9213828374

Committed 23 May 2024 07:34PM UTC coverage: 31.941% (+0.02%) from 31.922%

Build # 9213828374

Build Type

Pull #9212

github

Committed by

jimrandomh

Commit Message

Fix typing of onReady

Pull Request Pull Request #9212: [WIP] Upgrade CkEditor to v41

Run Details

4798 of 39071 branches covered (12.28%)

Branch coverage included in aggregate %.

7 of 21 new or added lines in 5 files covered. (33.33%)

39 existing lines in 1 file now uncovered.

27861 of 63177 relevant lines covered (44.1%)

180.57 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

37.5

/packages/lesswrong/components/editor/CKCommentEditor.tsx

import React from 'react'
import { registerComponent } from '../../lib/vulcan-lib/components';
import { ckEditorBundleVersion, getCkCommentEditor } from '../../lib/wrapCkEditor';
import { generateTokenRequest } from '../../lib/ckEditorUtils';
import { ckEditorUploadUrlSetting, ckEditorWebsocketUrlSetting } from '../../lib/publicSettings'
import { ckEditorUploadUrlOverrideSetting, ckEditorWebsocketUrlOverrideSetting, forumTypeSetting } from '../../lib/instanceSettings';
import { defaultEditorPlaceholder } from '../../lib/editor/make_editable';
import { mentionPluginConfiguration } from "../../lib/editor/mentionsConfig";
import { cloudinaryConfig } from '../../lib/editor/cloudinaryConfig'
import CKEditor from '../../lib/vendor/ckeditor5-react/ckeditor';
import type { Editor } from '@ckeditor/ckeditor5-core';

// Uncomment the import and the line below to activate the debugger
// import CKEditorInspector from '@ckeditor/ckeditor5-inspector';

const CKCommentEditor = ({
  data,
  collectionName,
  fieldName,
  onSave,
  onChange,
  onFocus,
  onReady,
  placeholder,
}: {
  data?: any,
  collectionName: CollectionNameString,
  fieldName: string,
  onSave?: any,
  onChange?: any,
  onFocus?: (event: AnyBecauseTodo, editor: AnyBecauseTodo) => void,
  onReady: (editor: Editor) => void,
  placeholder?: string,
}) => {
  const webSocketUrl = ckEditorWebsocketUrlOverrideSetting.get() || ckEditorWebsocketUrlSetting.get();
  const ckEditorCloudConfigured = !!webSocketUrl;
  const CommentEditor = getCkCommentEditor(forumTypeSetting.get());
  
  const editorConfig = {
    cloudServices: ckEditorCloudConfigured ? {
      // A tokenUrl token is needed here in order for image upload to work.
      // (It's accessible via drag-and-drop onto the comment box, and is
      // stored on CkEditor's CDN.)
      //
      // The collaborative editor is not activated because no `websocketUrl`
      // or `documentId` is provided.
      tokenUrl: generateTokenRequest(collectionName, fieldName),
      uploadUrl: ckEditorUploadUrlOverrideSetting.get() || ckEditorUploadUrlSetting.get(),
      bundleVersion: ckEditorBundleVersion,
    } : undefined,
    autosave: {
      save (editor: any) {
        return onSave && onSave( editor.getData() )
      }
    },
    initialData: data || "",
    placeholder: placeholder ?? defaultEditorPlaceholder,
    mention: mentionPluginConfiguration,
    ...cloudinaryConfig,
  };

  return <div>
    <CKEditor
      editor={CommentEditor}
      onReady={(editor: Editor) => {
        // Uncomment the line below and the import above to activate the debugger
        // CKEditorInspector.attach(editor)
        onReady(editor)
        return editor
      }}
      onChange={onChange}
      onFocus={onFocus}
      config={editorConfig}
      data={data}
      isCollaborative={false}
    />
  </div>
}

const CKCommentEditorComponent = registerComponent("CKCommentEditor", CKCommentEditor, {
  debugRerenders: true
});
declare global {
  interface ComponentTypes {
    CKCommentEditor: typeof CKCommentEditorComponent
  }
}

1	import React from 'react'	1✔
2	import { registerComponent } from '../../lib/vulcan-lib/components';	1✔
3	import { ckEditorBundleVersion, getCkCommentEditor } from '../../lib/wrapCkEditor';	1✔
4	import { generateTokenRequest } from '../../lib/ckEditorUtils';	1✔
5	import { ckEditorUploadUrlSetting, ckEditorWebsocketUrlSetting } from '../../lib/publicSettings'	1✔
6	import { ckEditorUploadUrlOverrideSetting, ckEditorWebsocketUrlOverrideSetting, forumTypeSetting } from '../../lib/instanceSettings';	1✔
7	import { defaultEditorPlaceholder } from '../../lib/editor/make_editable';	1✔
8	import { mentionPluginConfiguration } from "../../lib/editor/mentionsConfig";	1✔
9	import { cloudinaryConfig } from '../../lib/editor/cloudinaryConfig'	1✔
10	import CKEditor from '../../lib/vendor/ckeditor5-react/ckeditor';	1✔
11	import type { Editor } from '@ckeditor/ckeditor5-core';
12
13	// Uncomment the import and the line below to activate the debugger
14	// import CKEditorInspector from '@ckeditor/ckeditor5-inspector';
15
16	const CKCommentEditor = ({	1✔
17	data,
18	collectionName,
19	fieldName,
20	onSave,
21	onChange,
22	onFocus,
23	onReady,
24	placeholder,
25	}: {
26	data?: any,
27	collectionName: CollectionNameString,
28	fieldName: string,
29	onSave?: any,
30	onChange?: any,
31	onFocus?: (event: AnyBecauseTodo, editor: AnyBecauseTodo) => void,
32	onReady: (editor: Editor) => void,
33	placeholder?: string,
34	}) => {
35	const webSocketUrl = ckEditorWebsocketUrlOverrideSetting.get() \|\| ckEditorWebsocketUrlSetting.get();	×
36	const ckEditorCloudConfigured = !!webSocketUrl;	×
37	const CommentEditor = getCkCommentEditor(forumTypeSetting.get());	×
38
NEW 39	const editorConfig = {	×
40	cloudServices: ckEditorCloudConfigured ? {	×
41	// A tokenUrl token is needed here in order for image upload to work.
42	// (It's accessible via drag-and-drop onto the comment box, and is
43	// stored on CkEditor's CDN.)
44	//
45	// The collaborative editor is not activated because no `websocketUrl`
46	// or `documentId` is provided.
47	tokenUrl: generateTokenRequest(collectionName, fieldName),
48	uploadUrl: ckEditorUploadUrlOverrideSetting.get() \|\| ckEditorUploadUrlSetting.get(),	×
49	bundleVersion: ckEditorBundleVersion,
50	} : undefined,
51	autosave: {
52	save (editor: any) {
NEW 53	return onSave && onSave( editor.getData() )	×
54	}
55	},
56	initialData: data \|\| "",	×
57	placeholder: placeholder ?? defaultEditorPlaceholder,	×
58	mention: mentionPluginConfiguration,
59	...cloudinaryConfig,
60	};
61
62	return <div>	×
63	<CKEditor
64	editor={CommentEditor}
65	onReady={(editor: Editor) => {
66	// Uncomment the line below and the import above to activate the debugger
67	// CKEditorInspector.attach(editor)
NEW 68	onReady(editor)	×
69	return editor	×
70	}}
71	onChange={onChange}
72	onFocus={onFocus}
73	config={editorConfig}
74	data={data}
75	isCollaborative={false}
76	/>
77	</div>
78	}
79
80	const CKCommentEditorComponent = registerComponent("CKCommentEditor", CKCommentEditor, {	1✔
81	debugRerenders: true
82	});
83	declare global {
84	interface ComponentTypes {
85	CKCommentEditor: typeof CKCommentEditorComponent
86	}
87	}

ForumMagnum / ForumMagnum / 9213828374

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous