Migrate remaining files to TypeScript

.eslintrc.json

@@ -1,5 +1,10 @@
 {
-  "extends": ["airbnb-base", "airbnb-typescript/base", "prettier"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "project": "./tsconfig.json"
   },
@@ -8,33 +13,33 @@
     "commonjs": true,
     "es6": true
   },
-  "plugins": ["prettier"],
+  "plugins": ["prettier", "@typescript-eslint"],
   "settings": {
     "import/resolver": {
       "webpack": {
         "config": "_develop/webpack.config.js"
       }
     }
   },
+  "ignorePatterns": ["**/*.d.ts", "**/*.js"],
   "rules": {
+    "arrow-parens": ["error", "as-needed"],
     "class-methods-use-this": "off",
     "import/no-cycle": "off",
     "no-restricted-exports": "off",
     "@typescript-eslint/indent": "off",
     "@typescript-eslint/lines-between-class-members": "off",
     "@typescript-eslint/space-before-function-paren": "off",
     "@typescript-eslint/no-use-before-define": "off",
+    "@typescript-eslint/no-this-alias": "off",
     "@typescript-eslint/quotes": "off",
     "@typescript-eslint/comma-dangle": "off",
-    "import/no-extraneous-dependencies": [
-      "error",
-      {
-        "devDependencies": ["_develop/*.js", "test/**/*.js"]
-      }
-    ],
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/no-explicit-any": "off",
     "no-param-reassign": "off",
     "no-use-before-define": ["error", { "functions": false, "classes": false }],
-    "import/named": "error",
     "max-classes-per-file": "off",
     "prettier/prettier": "error"
   }

.gitignore

@@ -8,4 +8,16 @@
 /docs/_site
 /src
 *.d.ts
+*.js.map
 *.log
+
+blots/*.js
+core/*.js
+formats/*.js
+modules/*.js
+themes/*.js
+ui/*.js
+test/random.js
+
+core.js
+quill.js

.npmignore

@@ -0,0 +1,10 @@
+*.ts
+!*.d.ts
+.*
+Gemfile
+Gemfile.lock
+_develop
+.github
+.vscode
+docs
+test

blots/block.ts

@@ -16,14 +16,14 @@ const NEWLINE_LENGTH = 1;
 class Block extends BlockBlot {
   cache: { delta?: Delta | null; length?: number } = {};
 
-  delta() {
+  delta(): Delta {
     if (this.cache.delta == null) {
       this.cache.delta = blockDelta(this);
     }
     return this.cache.delta;
   }
 
-  deleteAt(index, length) {
+  deleteAt(index: number, length: number) {
     super.deleteAt(index, length);
     this.cache = {};
   }
@@ -153,7 +153,7 @@ class BlockEmbed extends EmbedBlot {
     this.format(name, value);
   }
 
-  insertAt(index, value, def) {
+  insertAt(index: number, value: string, def?: unknown) {
     if (typeof value === 'string' && value.endsWith('\n')) {
       const block = this.scroll.create(Block.blotName);
       this.parent.insertBefore(block, index === 0 ? this : this.next);

blots/scroll.ts

@@ -21,7 +21,7 @@ interface UpdatableEmbed {
 }
 
 function isUpdatable(blot: Blot): blot is Blot & UpdatableEmbed {
-  return typeof ((blot as unknown) as any).updateContent === 'function';
+  return typeof (blot as unknown as any).updateContent === 'function';
 }
 
 class Scroll extends ScrollBlot {
@@ -181,6 +181,11 @@ class Scroll extends ScrollBlot {
     return getLines(this, index, length);
   }
 
+  optimize(context: { [key: string]: any }): void;
+  optimize(
+    mutations?: MutationRecord[],
+    context?: { [key: string]: any },
+  ): void;
   optimize(mutations = [], context = {}) {
     if (this.batch) return;
     super.optimize(mutations, context);

core.ts

@@ -13,6 +13,9 @@ import Clipboard from './modules/clipboard';
 import History from './modules/history';
 import Keyboard from './modules/keyboard';
 import Uploader from './modules/uploader';
+import Delta, { Op, OpIterator, AttributeMap } from 'quill-delta';
+
+export { Delta, Op, OpIterator, AttributeMap };
 
 Quill.register({
   'blots/block': Block,

core/editor.ts

@@ -21,7 +21,7 @@ class Editor {
     this.delta = this.getDelta();
   }
 
-  applyDelta(delta: Delta) {
+  applyDelta(delta: Delta): Delta {
     this.scroll.update();
     let scrollLength = this.scroll.length();
     this.scroll.batchStart();
@@ -91,12 +91,16 @@ class Editor {
     return this.update(normalizedDelta);
   }
 
-  deleteText(index, length) {
+  deleteText(index: number, length: number): Delta {
     this.scroll.deleteAt(index, length);
     return this.update(new Delta().retain(index).delete(length));
   }
 
-  formatLine(index, length, formats = {}) {
+  formatLine(
+    index: number,
+    length: number,
+    formats: Record<string, unknown> = {},
+  ): Delta {
     this.scroll.update();
     Object.keys(formats).forEach(format => {
       this.scroll.lines(index, Math.max(length, 1)).forEach(line => {
@@ -108,25 +112,29 @@ class Editor {
     return this.update(delta);
   }
 
-  formatText(index, length, formats = {}) {
+  formatText(
+    index: number,
+    length: number,
+    formats: Record<string, unknown> = {},
+  ): Delta {
     Object.keys(formats).forEach(format => {
       this.scroll.formatAt(index, length, format, formats[format]);
     });
     const delta = new Delta().retain(index).retain(length, cloneDeep(formats));
     return this.update(delta);
   }
 
-  getContents(index, length) {
+  getContents(index: number, length: number): Delta {
     return this.delta.slice(index, index + length);
   }
 
-  getDelta() {
+  getDelta(): Delta {
     return this.scroll.lines().reduce((delta, line) => {
       return delta.concat(line.delta());
     }, new Delta());
   }
 
-  getFormat(index, length = 0) {
+  getFormat(index: number, length = 0): Record<string, unknown> {
     let lines = [];
     let leaves = [];
     if (length === 0) {
@@ -156,27 +164,31 @@ class Editor {
     return { ...lines, ...leaves };
   }
 
-  getHTML(index, length) {
+  getHTML(index: number, length: number): string {
     const [line, lineOffset] = this.scroll.line(index);
     if (line.length() >= lineOffset + length) {
       return convertHTML(line, lineOffset, length, true);
     }
     return convertHTML(this.scroll, index, length, true);
   }
 
-  getText(index, length) {
+  getText(index: number, length: number): string {
     return this.getContents(index, length)
       .filter(op => typeof op.insert === 'string')
       .map(op => op.insert)
       .join('');
   }
 
-  insertEmbed(index, embed, value) {
+  insertEmbed(index: number, embed: string, value: unknown): Delta {
     this.scroll.insertAt(index, embed, value);
     return this.update(new Delta().retain(index).insert({ [embed]: value }));
   }
 
-  insertText(index, text, formats = {}) {
+  insertText(
+    index: number,
+    text: string,
+    formats: Record<string, unknown> = {},
+  ): Delta {
     text = text.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
     this.scroll.insertAt(index, text);
     Object.keys(formats).forEach(format => {
@@ -187,7 +199,7 @@ class Editor {
     );
   }
 
-  isBlank() {
+  isBlank(): boolean {
     if (this.scroll.children.length === 0) return true;
     if (this.scroll.children.length > 1) return false;
     const blot = this.scroll.children.head;
@@ -197,7 +209,7 @@ class Editor {
     return block.children.head instanceof Break;
   }
 
-  removeFormat(index, length) {
+  removeFormat(index: number, length: number): Delta {
     const text = this.getText(index, length);
     const [line, offset] = this.scroll.line(index + length);
     let suffixLength = 0;
@@ -215,7 +227,7 @@ class Editor {
     return this.applyDelta(delta);
   }
 
-  update(change, mutations = [], selectionInfo = undefined) {
+  update(change: Delta, mutations = [], selectionInfo = undefined): Delta {
     const oldDelta = this.delta;
     if (
       mutations.length === 1 &&

core/emitter.ts

@@ -1,4 +1,4 @@
-import * as EventEmitter from 'eventemitter3';
+import EventEmitter from 'eventemitter3';
 import instances from './instances';
 import logger from './logger';
 
@@ -27,7 +27,7 @@ class Emitter extends EventEmitter<string> {
     SCROLL_EMBED_UPDATE: 'scroll-embed-update',
     SELECTION_CHANGE: 'selection-change',
     TEXT_CHANGE: 'text-change',
-  };
+  } as const;
 
   static sources = {
     API: 'api',
@@ -66,6 +66,7 @@ class Emitter extends EventEmitter<string> {
   }
 }
 
-export type EmitterSource = typeof Emitter.sources[keyof typeof Emitter.sources];
+export type EmitterSource =
+  typeof Emitter.sources[keyof typeof Emitter.sources];
 
 export default Emitter;

core/module.ts

@@ -1,9 +1,9 @@
 import Quill from './quill';
 
-class Module {
+abstract class Module<T extends {} = {}> {
   static DEFAULTS = {};
 
-  constructor(protected quill: Quill, protected options = {}) {}
+  constructor(protected quill: Quill, protected options: Partial<T> = {}) {}
 }
 
 export default Module;