9212205071

Committed 23 May 2024 05:17PM UTC coverage: 31.937% (+0.02%) from 31.922%

Build # 9212205071

Build Type

Pull #9212

github

Committed by

jimrandomh

Commit Message

Lint

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

Run Details

4796 of 39075 branches covered (12.27%)

Branch coverage included in aggregate %.

7 of 19 new or added lines in 5 files covered. (36.84%)

1 existing line in 1 file now uncovered.

27860 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

35.29

/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';

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

ForumMagnum / ForumMagnum / 9212205071

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