feat(plugin): upd deps and replace option with option

diplodoc-platform · Nov 13, 2024 · edb51bc · edb51bc
1 parent 4efae92
commit edb51bc
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 35 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -47,7 +47,7 @@
     "prepare": "husky"
   },
   "dependencies": {
-    "@diplodoc/directive": "file:../diplodoc-directive/diplodoc-directive-0.0.0-8.tgz"
+    "@diplodoc/directive": "^0.1.0"
   },
   "devDependencies": {
     "@diplodoc/lint": "^1.2.0",

diff --git a/src/plugin/transform.ts b/src/plugin/transform.ts
@@ -5,8 +5,6 @@ import {type Runtime, copyRuntime, dynrequire, hidden} from './utils';
 import {ENV_FLAG_NAME} from './const';
 import {cutDirective} from './directive';
 
-type Syntax = 'both' | 'curly' | 'directive';
-
 export type TransformOptions = {
     runtime?:
         | string
@@ -15,30 +13,38 @@ export type TransformOptions = {
               style: string;
           };
     bundle?: boolean;
-    /** @default 'curly' */
-    syntax?: Syntax;
+    /**
+     * Enables directive syntax of yfm-cut.
+     *
+     * - 'disabled' – directive syntax is disabled.
+     * - 'enabled' – directive syntax is enabled; old syntax is also enabled.
+     * - 'only' – enabled only directive syntax; old syntax is disabled.
+     *
+     * @default 'disabled'
+     */
+    directiveSyntax?: 'disabled' | 'enabled' | 'only';
 };
 
-type NormalizedPluginOptions = Omit<TransformOptions, 'runtime' | 'syntax'> & {
+type NormalizedPluginOptions = Omit<TransformOptions, 'runtime' | 'directiveSyntax'> & {
     runtime: Runtime;
-    syntax: Syntax;
+    directiveSyntax: NonNullable<TransformOptions['directiveSyntax']>;
 };
 
 const registerTransform = (
     md: MarkdownIt,
     {
         runtime,
         bundle,
-        syntax,
         output,
-    }: Pick<NormalizedPluginOptions, 'bundle' | 'runtime' | 'syntax'> & {
+        directiveSyntax,
+    }: Pick<NormalizedPluginOptions, 'bundle' | 'runtime' | 'directiveSyntax'> & {
         output: string;
     },
 ) => {
-    if (syntax === 'curly' || syntax === 'both') {
+    if (directiveSyntax === 'disabled' || directiveSyntax === 'enabled') {
         md.use(cutPlugin);
     }
-    if (syntax === 'directive' || syntax === 'both') {
+    if (directiveSyntax === 'enabled' || directiveSyntax === 'only') {
         md.use(cutDirective);
     }
     md.core.ruler.push('yfm_cut_after', ({env}) => {
@@ -69,8 +75,7 @@ export function transform(options: Partial<TransformOptions> = {}) {
         throw new TypeError('Option `runtime` should be record when `bundle` is enabled.');
     }
 
-    const syntax: Syntax = options.syntax ?? 'curly';
-
+    const directiveSyntax = options.directiveSyntax || 'disabled';
     const runtime: Runtime =
         typeof options.runtime === 'string'
             ? {script: options.runtime, style: options.runtime}
@@ -84,7 +89,7 @@ export function transform(options: Partial<TransformOptions> = {}) {
         {output = '.'} = {},
     ) {
         registerTransform(md, {
-            syntax,
+            directiveSyntax,
             runtime,
             bundle,
             output,
@@ -96,7 +101,7 @@ export function transform(options: Partial<TransformOptions> = {}) {
             const MdIt = dynrequire('markdown-it');
             const md = new MdIt().use((md: MarkdownIt) => {
                 registerTransform(md, {
-                    syntax,
+                    directiveSyntax,
                     runtime,
                     bundle,
                     output: destRoot,

diff --git a/tests/src/__snapshots__/plugin.test.ts.snap b/tests/src/__snapshots__/plugin.test.ts.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Cut extension - plugin Options: syntax should render both cuts 1`] = `
+exports[`Cut extension - plugin Options: directiveSyntax should render both cuts 1`] = `
 <details class="yfm-cut">
   <summary class="yfm-cut-title">
     Old cut
@@ -23,7 +23,7 @@ exports[`Cut extension - plugin Options: syntax should render both cuts 1`] = `
 </details>
 `;
 
-exports[`Cut extension - plugin Options: syntax should render only new (directive) cut 1`] = `
+exports[`Cut extension - plugin Options: directiveSyntax should render only new (directive) cut 1`] = `
 <p>
 </p>
 <p>
@@ -43,7 +43,7 @@ exports[`Cut extension - plugin Options: syntax should render only new (directiv
 </details>
 `;
 
-exports[`Cut extension - plugin Options: syntax should render only old (curly) cut 1`] = `
+exports[`Cut extension - plugin Options: directiveSyntax should render only old (curly) cut 1`] = `
 <details class="yfm-cut">
   <summary class="yfm-cut-title">
     Old cut

diff --git a/tests/src/plugin.test.ts b/tests/src/plugin.test.ts
@@ -219,7 +219,7 @@ describe('Cut extension - plugin', () => {
                 Cut content
                 :::
                 `,
-                    {syntax: 'directive'},
+                    {directiveSyntax: 'only'},
                 ),
             ).toMatchSnapshot();
         });
@@ -236,7 +236,7 @@ describe('Cut extension - plugin', () => {
                 :::
                 :::
                 `,
-                    {syntax: 'directive'},
+                    {directiveSyntax: 'only'},
                 ),
             ).toMatchSnapshot();
         });
@@ -249,13 +249,13 @@ describe('Cut extension - plugin', () => {
                 Content we want to hide
                 :::
                 `,
-                    {syntax: 'directive'},
+                    {directiveSyntax: 'only'},
                 ),
             ).toMatchSnapshot();
         });
 
         it('should dont add assets to meta if no yfm-cut is found', () => {
-            expect(meta('paragraph', {syntax: 'directive'})).toBeUndefined();
+            expect(meta('paragraph', {directiveSyntax: 'only'})).toBeUndefined();
         });
 
         it('should add assets to meta', () => {
@@ -266,7 +266,7 @@ describe('Cut extension - plugin', () => {
                 Cut content
                 :::
                 `,
-                    {syntax: 'directive'},
+                    {directiveSyntax: 'only'},
                 ),
             ).toStrictEqual({
                 script: ['_assets/cut-extension.js'],
@@ -286,7 +286,7 @@ describe('Cut extension - plugin', () => {
 
 
                 `,
-                    {syntax: 'directive'},
+                    {directiveSyntax: 'only'},
                 ),
             ).toMatchSnapshot();
         });
@@ -298,7 +298,7 @@ describe('Cut extension - plugin', () => {
                 :::cut
                 Cut content
                 :::`,
-                    {syntax: 'directive'},
+                    {directiveSyntax: 'only'},
                 ),
             ).toMatchSnapshot();
         });
@@ -309,7 +309,7 @@ describe('Cut extension - plugin', () => {
                     dd`
                 ::cut[Title]
                 `,
-                    {syntax: 'directive'},
+                    {directiveSyntax: 'only'},
                 ),
             ).toMatchSnapshot();
         });
@@ -320,13 +320,13 @@ describe('Cut extension - plugin', () => {
                     dd`
                 ::cut[Title]
                 `,
-                    {syntax: 'directive'},
+                    {directiveSyntax: 'only'},
                 ),
             ).toBeUndefined();
         });
     });
 
-    describe('Options: syntax', () => {
+    describe('Options: directiveSyntax', () => {
         const markup = dd`
             {% cut "Old cut" %}
 
@@ -340,15 +340,15 @@ describe('Cut extension - plugin', () => {
             `;
 
         it('should render only old (curly) cut', () => {
-            expect(html(markup, {syntax: 'curly'})).toMatchSnapshot();
+            expect(html(markup, {directiveSyntax: 'disabled'})).toMatchSnapshot();
         });
 
         it('should render only new (directive) cut', () => {
-            expect(html(markup, {syntax: 'directive'})).toMatchSnapshot();
+            expect(html(markup, {directiveSyntax: 'only'})).toMatchSnapshot();
         });
 
         it('should render both cuts', () => {
-            expect(html(markup, {syntax: 'both'})).toMatchSnapshot();
+            expect(html(markup, {directiveSyntax: 'enabled'})).toMatchSnapshot();
         });
     });
 });