Merge pull request #26305 from 43081j/doctrineless

Docs-tools: Replace `doctrine` with `jsdoc-type-pratt-parser`
storybookjs · Jun 10, 2024 · 2cbf3a7 · 2cbf3a7
2 parents 9b8b946 + e20977a
commit 2cbf3a7
Show file tree

Hide file tree

Showing 7 changed files with 376 additions and 268 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -601,6 +601,8 @@ jobs:
           name: Install dependencies
           command: yarn install --no-immutable
           working_directory: test-storybooks/portable-stories-kitchen-sink/<< parameters.directory >>
+          environment:
+            YARN_ENABLE_IMMUTABLE_INSTALLS: false
       - run:
           name: Run Jest tests
           command: yarn jest

diff --git a/code/lib/docs-tools/package.json b/code/lib/docs-tools/package.json
@@ -48,9 +48,8 @@
     "@storybook/core-events": "workspace:*",
     "@storybook/preview-api": "workspace:*",
     "@storybook/types": "workspace:*",
-    "@types/doctrine": "^0.0.3",
-    "assert": "^2.1.0",
-    "doctrine": "^3.0.0",
+    "comment-parser": "^1.4.1",
+    "jsdoc-type-pratt-parser": "^4.0.0",
     "lodash": "^4.17.21"
   },
   "devDependencies": {

diff --git a/code/lib/docs-tools/src/argTypes/jsdocParser.test.ts b/code/lib/docs-tools/src/argTypes/jsdocParser.test.ts
@@ -10,7 +10,7 @@ describe('parseJsDoc', () => {
     expect(extractedTags).toBeUndefined();
   });
 
-  it('should set includesJsDocto to false when the value dont contains JSDoc', () => {
+  it('should set includesJsDoc to false when the value dont contains JSDoc', () => {
     const { includesJsDoc, description, extractedTags } = parseJsDoc('Hey!');
 
     expect(includesJsDoc).toBeFalsy();
@@ -68,7 +68,7 @@ describe('parseJsDoc', () => {
       expect(extractedTags?.params).not.toBeNull();
       expect(extractedTags?.params?.[0].name).toBe('event');
       expect(extractedTags?.params?.[0].type).not.toBeNull();
-      expect(extractedTags?.params?.[0].type.name).toBe('SyntheticEvent');
+      expect(extractedTags?.params?.[0].type.value).toBe('SyntheticEvent');
       expect(extractedTags?.params?.[0].description).toBeNull();
     });
 
@@ -78,7 +78,7 @@ describe('parseJsDoc', () => {
       expect(extractedTags?.params).not.toBeNull();
       expect(extractedTags?.params?.[0].name).toBe('event');
       expect(extractedTags?.params?.[0].type).not.toBeNull();
-      expect(extractedTags?.params?.[0].type.name).toBe('SyntheticEvent');
+      expect(extractedTags?.params?.[0].type.value).toBe('SyntheticEvent');
       expect(extractedTags?.params?.[0].description).toBe('React event');
     });
 
@@ -90,7 +90,7 @@ describe('parseJsDoc', () => {
       ['event1', 'event2', 'event3'].forEach((x, i) => {
         expect(extractedTags?.params?.[i].name).toBe(x);
         expect(extractedTags?.params?.[i].type).not.toBeNull();
-        expect(extractedTags?.params?.[i].type.name).toBe('SyntheticEvent');
+        expect(extractedTags?.params?.[i].type.value).toBe('SyntheticEvent');
         expect(extractedTags?.params?.[i].description).toBe('React event');
       });
     });
@@ -129,7 +129,7 @@ describe('parseJsDoc', () => {
         expect(extractedTags?.params).not.toBeNull();
         expect(extractedTags?.params?.[0].name).toBe('event');
         expect(extractedTags?.params?.[0].type).not.toBeNull();
-        expect(extractedTags?.params?.[0].type.name).toBe('SyntheticEvent');
+        expect(extractedTags?.params?.[0].type.value).toBe('SyntheticEvent');
         expect(extractedTags?.params?.[0].description).toBe('React event');
       });
     });
@@ -251,15 +251,15 @@ describe('parseJsDoc', () => {
 
       expect(extractedTags?.returns).not.toBeNull();
       expect(extractedTags?.returns?.type).not.toBeNull();
-      expect(extractedTags?.returns?.type.name).toBe('string');
+      expect(extractedTags?.returns?.type.value).toBe('string');
     });
 
     it('should return a @returns with a type and a description', () => {
       const { extractedTags } = parseJsDoc('@returns {string} - A bar description');
 
       expect(extractedTags?.returns).not.toBeNull();
       expect(extractedTags?.returns?.type).not.toBeNull();
-      expect(extractedTags?.returns?.type.name).toBe('string');
+      expect(extractedTags?.returns?.type.value).toBe('string');
       expect(extractedTags?.returns?.description).toBe('A bar description');
     });
 
@@ -270,7 +270,7 @@ describe('parseJsDoc', () => {
 
       expect(extractedTags?.returns).not.toBeNull();
       expect(extractedTags?.returns?.type).not.toBeNull();
-      expect(extractedTags?.returns?.type.name).toBe('string');
+      expect(extractedTags?.returns?.type.value).toBe('string');
       expect(extractedTags?.returns?.description).toBe('This is\na multiline\ndescription');
     });
 
@@ -279,7 +279,7 @@ describe('parseJsDoc', () => {
 
       expect(extractedTags?.returns).not.toBeNull();
       expect(extractedTags?.returns?.type).not.toBeNull();
-      expect(extractedTags?.returns?.type.name).toBe('number');
+      expect(extractedTags?.returns?.type.value).toBe('number');
     });
 
     describe('getTypeName', () => {
@@ -353,9 +353,9 @@ describe('parseJsDoc', () => {
     expect(extractedTags?.params).not.toBeNull();
     expect(Object.keys(extractedTags?.params ?? []).length).toBe(1);
     expect(extractedTags?.params?.[0].name).toBe('event');
-    expect(extractedTags?.params?.[0].type.name).toBe('SyntheticEvent');
+    expect(extractedTags?.params?.[0].type.value).toBe('SyntheticEvent');
     expect(extractedTags?.params?.[0].description).toBe('Original event.');
     expect(extractedTags?.returns).not.toBeNull();
-    expect(extractedTags?.returns?.type.name).toBe('string');
+    expect(extractedTags?.returns?.type.value).toBe('string');
   });
 });