@doist/typist 1.0.0

package/dist/serializers/markdown/plugins/paragraph.js

@@ -0,0 +1,18 @@
+/**
+ * A Turndown plugin which adds a custom rule for paragraphs. This custom rule is required to avoid
+ * adding unnecessary blank lines between paragraphs to plain-text documents.
+ *
+ * @param nodeType The node object that matches this rule.
+ * @param isPlainText Specifies if the schema represents a plain-text document.
+ */
+function paragraph(nodeType, isPlainText) {
+    return (turndown) => {
+        turndown.addRule(nodeType.name, {
+            filter: 'p',
+            replacement: function (content) {
+                return isPlainText ? `\n${content}\n` : `\n\n${content}\n\n`;
+            },
+        });
+    };
+}
+export { paragraph };

package/dist/serializers/markdown/plugins/strikethrough.d.ts

@@ -0,0 +1,13 @@
+import type { MarkType } from 'prosemirror-model';
+import type Turndown from 'turndown';
+/**
+ * A Turndown plugin which adds a rule for strikethrough text, based on the original plugin. This
+ * rules forces two tildes instead of one.
+ *
+ * @see https://github.com/mixmark-io/turndown-plugin-gfm/blob/v1.0.1/src/strikethrough.js
+ *
+ * @param markType The mark object that matches this rule.
+ */
+declare function strikethrough(markType: MarkType): Turndown.Plugin;
+export { strikethrough };
+//# sourceMappingURL=strikethrough.d.ts.map

package/dist/serializers/markdown/plugins/strikethrough.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strikethrough.d.ts","sourceRoot":"","sources":["../../../../src/serializers/markdown/plugins/strikethrough.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAA;AAEpC;;;;;;;GAOG;AACH,iBAAS,aAAa,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAa1D;AAED,OAAO,EAAE,aAAa,EAAE,CAAA"}

package/dist/serializers/markdown/plugins/strikethrough.js

@@ -0,0 +1,23 @@
+import { extractTagsFromParseRules } from '../../../helpers/serializer';
+/**
+ * A Turndown plugin which adds a rule for strikethrough text, based on the original plugin. This
+ * rules forces two tildes instead of one.
+ *
+ * @see https://github.com/mixmark-io/turndown-plugin-gfm/blob/v1.0.1/src/strikethrough.js
+ *
+ * @param markType The mark object that matches this rule.
+ */
+function strikethrough(markType) {
+    const tags = extractTagsFromParseRules(markType.spec.parseDOM);
+    return (turndown) => {
+        turndown.addRule(markType.name, {
+            filter: (node) => {
+                return tags.some((tag) => tag.toUpperCase() === node.nodeName);
+            },
+            replacement: (content) => {
+                return `~~${content}~~`;
+            },
+        });
+    };
+}
+export { strikethrough };

package/dist/serializers/markdown/plugins/suggestion.d.ts

@@ -0,0 +1,11 @@
+import type { NodeType } from 'prosemirror-model';
+import type Turndown from 'turndown';
+/**
+ * A Turndown plugin which adds a custom rule for suggestion nodes created by the suggestion
+ * extension factory function.
+ *
+ * @param nodeType The node object that matches this rule.
+ */
+declare function suggestion(nodeType: NodeType): Turndown.Plugin;
+export { suggestion };
+//# sourceMappingURL=suggestion.d.ts.map

package/dist/serializers/markdown/plugins/suggestion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggestion.d.ts","sourceRoot":"","sources":["../../../../src/serializers/markdown/plugins/suggestion.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAA;AAEpC;;;;;GAKG;AACH,iBAAS,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAcvD;AAED,OAAO,EAAE,UAAU,EAAE,CAAA"}

package/dist/serializers/markdown/plugins/suggestion.js

@@ -0,0 +1,21 @@
+import { kebabCase } from 'lodash-es';
+/**
+ * A Turndown plugin which adds a custom rule for suggestion nodes created by the suggestion
+ * extension factory function.
+ *
+ * @param nodeType The node object that matches this rule.
+ */
+function suggestion(nodeType) {
+    const attributeType = kebabCase(nodeType.name.replace(/Suggestion$/, ''));
+    return (turndown) => {
+        turndown.addRule(nodeType.name, {
+            filter: (node) => node.hasAttribute(`data-${attributeType}`),
+            replacement: (_, node) => {
+                const label = String(node.getAttribute('data-label'));
+                const id = String(node.getAttribute('data-id'));
+                return `[${label}](${attributeType}://${id})`;
+            },
+        });
+    };
+}
+export { suggestion };

package/dist/serializers/markdown/plugins/task-item.d.ts

@@ -0,0 +1,14 @@
+import type { NodeType } from 'prosemirror-model';
+import type Turndown from 'turndown';
+/**
+ * A Turndown plugin which adds a rule for task list items (i.e., `* [ ] Task`), based on the
+ * original list item rule. This rule not only avoids conflicts with standard list items, but also
+ * normalizes the Markdown output.
+ *
+ * @see https://github.com/mixmark-io/turndown/blob/v7.1.1/src/commonmark-rules.js#L61
+ *
+ * @param nodeType The node object that matches this rule.
+ */
+declare function taskItem(nodeType: NodeType): Turndown.Plugin;
+export { taskItem };
+//# sourceMappingURL=task-item.d.ts.map

package/dist/serializers/markdown/plugins/task-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"task-item.d.ts","sourceRoot":"","sources":["../../../../src/serializers/markdown/plugins/task-item.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAA;AAEpC;;;;;;;;GAQG;AACH,iBAAS,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAkCrD;AAED,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/dist/serializers/markdown/plugins/task-item.js

@@ -0,0 +1,39 @@
+import { extractTagsFromParseRules } from '../../../helpers/serializer';
+import { BULLET_LIST_MARKER } from '../markdown';
+/**
+ * A Turndown plugin which adds a rule for task list items (i.e., `* [ ] Task`), based on the
+ * original list item rule. This rule not only avoids conflicts with standard list items, but also
+ * normalizes the Markdown output.
+ *
+ * @see https://github.com/mixmark-io/turndown/blob/v7.1.1/src/commonmark-rules.js#L61
+ *
+ * @param nodeType The node object that matches this rule.
+ */
+function taskItem(nodeType) {
+    const tags = extractTagsFromParseRules(nodeType.spec.parseDOM);
+    return (turndown) => {
+        turndown.addRule(nodeType.name, {
+            filter: (node) => {
+                return (tags.some((tag) => tag.toUpperCase().startsWith(node.nodeName)) &&
+                    node.getAttribute('data-type') === 'taskItem');
+            },
+            replacement: function (content, node) {
+                const parentNode = node.parentNode;
+                let listItemMarker = `${BULLET_LIST_MARKER} `;
+                if (parentNode?.nodeName === 'UL') {
+                    const checked = node.getAttribute('data-checked');
+                    listItemMarker = `${listItemMarker}${checked === 'true' ? '[x]' : '[ ]'} `;
+                }
+                const newContent = content
+                    // Remove leading newlines
+                    .replace(/^\n+/, '')
+                    // Replace trailing newlines with a single one
+                    .replace(/\n+$/, '\n')
+                    // Indent list items with 4 spaces
+                    .replace(/\s*\n/gm, '\n    ');
+                return `${listItemMarker}${newContent.trim()}${node.nextSibling && !newContent.endsWith('\n') ? '\n' : ''}`;
+            },
+        });
+    };
+}
+export { taskItem };

package/package.json

@@ -0,0 +1,146 @@
+{
+    "name": "@doist/typist",
+    "description": "The mighty Tiptap-based rich-text editor that powers Doist products.",
+    "version": "1.0.0",
+    "license": "MIT",
+    "homepage": "https://typist.doist.dev/",
+    "repository": "https://github.com/Doist/typist",
+    "prettier": "@doist/prettier-config",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "sideEffects": false,
+    "engines": {
+        "node": "^16.0.0 || ^18.0.0",
+        "npm": "^7.0.0 || ^8.0.0 || ^9.0.0"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "files": [
+        "CHANGELOG.md",
+        "CODE_OF_CONDUCT.md",
+        "CONTRIBUTING.md",
+        "LICENSE",
+        "README.md",
+        "dist/**"
+    ],
+    "scripts": {
+        "build": "run-s clean:* typist:build",
+        "check": "run-s prettier:check eslint:check typescript:check",
+        "clean": "run-s clean:*",
+        "clean:cache": "rimraf .cache/",
+        "clean:dist": "rimraf dist/",
+        "clean:storybook-static": "rimraf storybook-static/",
+        "eslint:check": "eslint --format codeframe --cache --cache-location ./.cache/.eslintcache --ext js,jsx,ts,tsx ./",
+        "format": "run-s prettier:format",
+        "prepare": "is-ci || husky install",
+        "prettier:check": "prettier --check \"./**/*.{js,jsx,ts,tsx,json,css,yml,md}\"",
+        "prettier:format": "prettier --write \"./**/*.{js,jsx,ts,tsx,json,css,yml,md}\"",
+        "storybook:build": "build-storybook",
+        "storybook:start": "start-storybook --port 6006 --no-manager-cache --ci",
+        "test": "jest",
+        "test:watch": "jest --watch",
+        "typescript:check": "tsc --project tsconfig.json",
+        "typist:build": "tsc --build tsconfig.build.json",
+        "validate:pre-commit": "lint-staged",
+        "validate:pre-push": "run-s test"
+    },
+    "dependencies": {
+        "@tiptap/core": "2.0.0-beta.200",
+        "@tiptap/extension-blockquote": "2.0.0-beta.200",
+        "@tiptap/extension-bold": "2.0.0-beta.200",
+        "@tiptap/extension-bullet-list": "2.0.0-beta.200",
+        "@tiptap/extension-character-count": "2.0.0-beta.200",
+        "@tiptap/extension-code": "2.0.0-beta.200",
+        "@tiptap/extension-code-block": "2.0.0-beta.200",
+        "@tiptap/extension-document": "2.0.0-beta.200",
+        "@tiptap/extension-dropcursor": "2.0.0-beta.200",
+        "@tiptap/extension-gapcursor": "2.0.0-beta.200",
+        "@tiptap/extension-hard-break": "2.0.0-beta.200",
+        "@tiptap/extension-heading": "2.0.0-beta.200",
+        "@tiptap/extension-history": "2.0.0-beta.200",
+        "@tiptap/extension-horizontal-rule": "2.0.0-beta.200",
+        "@tiptap/extension-image": "2.0.0-beta.200",
+        "@tiptap/extension-italic": "2.0.0-beta.200",
+        "@tiptap/extension-link": "2.0.0-beta.200",
+        "@tiptap/extension-list-item": "2.0.0-beta.200",
+        "@tiptap/extension-ordered-list": "2.0.0-beta.200",
+        "@tiptap/extension-paragraph": "2.0.0-beta.200",
+        "@tiptap/extension-placeholder": "2.0.0-beta.200",
+        "@tiptap/extension-strike": "2.0.0-beta.200",
+        "@tiptap/extension-task-item": "2.0.0-beta.200",
+        "@tiptap/extension-task-list": "2.0.0-beta.200",
+        "@tiptap/extension-text": "2.0.0-beta.200",
+        "@tiptap/extension-typography": "2.0.0-beta.200",
+        "@tiptap/react": "2.0.0-beta.200",
+        "@tiptap/suggestion": "2.0.0-beta.200",
+        "prosemirror-codemark": "0.4.1",
+        "prosemirror-model": "1.18.1",
+        "prosemirror-state": "1.4.2",
+        "prosemirror-view": "1.29.0"
+    },
+    "devDependencies": {
+        "@doist/eslint-config": "8.0.1",
+        "@doist/prettier-config": "3.0.5",
+        "@doist/reactist": "15.3.0",
+        "@mdx-js/react": "2.1.5",
+        "@semantic-release/changelog": "6.0.1",
+        "@semantic-release/exec": "6.0.3",
+        "@semantic-release/git": "10.0.1",
+        "@storybook/addon-a11y": "6.5.13",
+        "@storybook/addon-essentials": "6.5.13",
+        "@storybook/addons": "6.5.13",
+        "@storybook/builder-vite": "0.2.5",
+        "@storybook/mdx2-csf": "0.0.3",
+        "@storybook/react": "6.5.13",
+        "@testing-library/dom": "8.19.0",
+        "@testing-library/jest-dom": "5.16.5",
+        "@testing-library/react": "13.4.0",
+        "@types/jest": "29.2.1",
+        "@types/lodash-es": "4.17.6",
+        "@types/marked": "4.0.7",
+        "@types/react": "18.0.24",
+        "@types/react-dom": "18.0.8",
+        "@types/turndown": "5.0.1",
+        "boring-avatars": "1.7.0",
+        "classnames": "2.3.2",
+        "conventional-changelog-conventionalcommits": "5.0.0",
+        "emoji-regex": "10.2.1",
+        "eslint": "8.26.0",
+        "eslint-formatter-codeframe": "7.32.1",
+        "eslint-import-resolver-typescript": "3.5.2",
+        "eslint-plugin-jest": "27.1.3",
+        "eslint-plugin-simple-import-sort": "8.0.0",
+        "eslint-plugin-unicorn": "44.0.2",
+        "github-markdown-css": "5.1.0",
+        "husky": "8.0.1",
+        "ignore-sync": "6.0.2",
+        "is-ci": "3.0.1",
+        "jest": "29.2.2",
+        "jest-environment-jsdom": "29.2.2",
+        "lint-staged": "13.0.3",
+        "npm-run-all": "4.1.5",
+        "prettier": "2.7.1",
+        "react-icons": "4.6.0",
+        "rimraf": "3.0.2",
+        "semantic-release": "19.0.5",
+        "storybook-css-modules": "1.0.8",
+        "ts-jest": "29.0.3",
+        "ts-node": "10.9.1",
+        "type-fest": "3.1.0",
+        "typescript": "4.8.4",
+        "typescript-plugin-css-modules": "3.4.0"
+    },
+    "peerDependencies": {
+        "@react-hookz/web": "^14.2.3 || >=15.x",
+        "emoji-regex": "^10.2.1",
+        "lodash-es": "^4.17.21",
+        "marked": "^4.1.1",
+        "react": "^17.0.0 || ^18.0.0",
+        "react-dom": "^17.0.0 || ^18.0.0",
+        "react-use-event-hook": "^0.9.3",
+        "tippy.js": "^6.3.7",
+        "turndown": "^7.1.1"
+    }
+}