Release 4.0.0-beta10

Author: demsking

.eslintignore

@@ -1,6 +1,8 @@
 test/MethodParser.spec.js
 test/issues.spec.js
+test/fake_node_modules
 test/examples
+test/fixtures
 test/tutorial
-jest.config.js
 sample.js
+esm/

.eslintrc.yaml

@@ -2,13 +2,33 @@
 root: true
 env:
   node: true
+parser: '@typescript-eslint/parser'
+plugins:
+  - import
+  - unused-imports
+  - '@typescript-eslint'
 extends:
   - eslint:recommended
   - airbnb-base
+  - plugin:import/recommended
+  - plugin:import/typescript
+  - plugin:@typescript-eslint/recommended
+  - plugin:security/recommended
 parserOptions:
-  ecmaVersion: 13
+  ecmaVersion: 2019
   sourceType: module
 rules:
+  '@typescript-eslint/ban-types': 'off'
+  '@typescript-eslint/indent': 'off'
+  '@typescript-eslint/explicit-function-return-type': 'off'
+  '@typescript-eslint/explicit-member-accessibility': 'off'
+  '@typescript-eslint/interface-name-prefix': 'off'
+  '@typescript-eslint/no-empty-function': 'off'
+  '@typescript-eslint/no-explicit-any': 'off'
+  '@typescript-eslint/no-empty-interface': 'off'
+  '@typescript-eslint/no-this-alias': 'off'
+  '@typescript-eslint/no-unused-vars': 'off'
+  '@typescript-eslint/no-var-requires': 'off'
   arrow-body-style: 'off'
   array-bracket-spacing:
     - error
@@ -24,9 +44,6 @@ rules:
       imports: never
       exports: never
       functions: never
-  complexity:
-    - error
-    - max: 40
   class-methods-use-this: 'off'
   default-case: 'off'
   global-require: 'off'
@@ -35,15 +52,15 @@ rules:
   import/extensions:
     - 'error'
     - 'always'
-    - ignorePackages: true
+    - ignorePackages: false
   import/named: 'off'
   import/no-cycle: 'off'
   import/no-dynamic-require: 'off'
   import/no-extraneous-dependencies: 'off'
   import/no-named-as-default: 'off'
   import/no-named-as-default-member: 'off'
   import/no-unresolved:
-    - 'error'
+    - 'off'
   import/order: 'off'
   import/prefer-default-export: 'off'
   jest/expect-expect: 'off'
@@ -61,12 +78,13 @@ rules:
   no-use-before-define: 'off'
   no-restricted-syntax: 'off'
   no-shadow: 'off'
+  no-trailing-spaces: 'error'
   no-useless-constructor: 'off'
   no-var: error
   max-classes-per-file: 'off'
   max-len:
     - error
-    - code: 128
+    - code: 148
       comments: 128
       tabWidth: 2
       ignoreUrls: true
@@ -126,6 +144,10 @@ rules:
     - error
     - single
     - avoidEscape: true
+  security/detect-non-literal-fs-filename: 'off'
+  security/detect-non-literal-regexp: 'off'
+  security/detect-object-injection: 'off'
+  security/detect-unsafe-regex: 'off'
   semi:
     - error
     - always
@@ -134,11 +156,22 @@ rules:
     - anonymous: never
       named: never
       asyncArrow: always
+  unused-imports/no-unused-imports: 'error'
+  unused-imports/no-unused-vars:
+    - warn
+    - vars: all
+      varsIgnorePattern: '^_'
+      args: after-used
+      argsIgnorePattern: '^_'
 overrides:
+  - files:
+      - '**/*.d.ts'
+    rules:
+      import/extensions: 'off'
+      max-len: 'off'
+      unused-imports/no-unused-vars: 'off'
   - files:
       - '**/test/**'
-    env:
-      jest: true
     rules:
       max-len: 'off'
       indent: 'off'

.gitignore

@@ -42,11 +42,14 @@ jspm_packages
 # CodeLineX
 .codeline/
 
-# vscode
-.vscode/
-
 # Nix
 .nix-node
 
 # Archives
 *.tgz
+
+*.odp
+*.pdf
+*.png
+esm/
+sample.js

.gitlab-ci.yml

@@ -1,8 +1,5 @@
 image: node:lts-alpine
 
-include:
-  - template: SAST.gitlab-ci.yml
-
 stages:
   - tests
   - security
@@ -25,34 +22,30 @@ tests & coverage:
   stage: tests
   script:
     - yarn install
-    - yarn test
+    - yarn coverage
   coverage: '/All files[^|]*\|[^|]*\s+([\d\.]+)/'
   artifacts:
     paths:
       - coverage/
 
 security audit:
   stage: security
-  needs: &tests-jobs
+  needs:
     - code quality
     - dependencies outdated
     - tests & coverage
   script:
     - yarn audit --level high --groups dependencies
 
-sast:
-  stage: security
-  needs: *tests-jobs
-
 pages:
   stage: publish
-  needs: &security-jobs
+  needs:
     - tests & coverage
     - security audit
   dependencies:
     - tests & coverage
   script:
-    - mv coverage/lcov-report/ public/
+    - mv coverage/ public/
   artifacts:
     paths:
       - public
@@ -65,21 +58,27 @@ pages:
 
 package:
   stage: publish
-  needs: *security-jobs
+  needs:
+    - security audit
   script:
+    - yarn install
+    - yarn build
     - yarn pack
   artifacts:
     paths:
       - ./*.tgz
 
 publish:
   stage: publish
-  needs: *security-jobs
+  needs:
+    - security audit
   only:
     - tags
     - triggers
   script:
     - echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > .npmrc
+    - yarn install
+    - yarn build
     - yarn publish
   environment:
     name: npm

.npmignore

@@ -2,9 +2,13 @@ test
 coverage
 .*
 sample.js
-jest.config.js
+vitest.config.ts
 result.json
+tsconfig.json
 *.tgz
 *.nix
 *.yml
 *.yaml
+*.odp
+*.pdf
+*.png

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "fabiospampinato.vscode-todo-plus",
+    "wayou.vscode-todo-highlight",
+    "ZixuanChen.vitest-explorer"
+  ]
+}

.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "pwa-node",
+      "request": "launch",
+      "name": "Debug Current Test File",
+      "autoAttachChildProcesses": true,
+      "skipFiles": [
+        "<node_internals>/**",
+        "**/node_modules/**",
+        "**/coverage/**",
+        "**/esm/**"
+      ],
+      "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
+      "args": ["run", "${relativeFile}"],
+      "smartStep": true,
+      "console": "integratedTerminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,60 @@
+{
+  "todo.file.exclude": [
+    "**/esm/**",
+    "**/.!(todo|todos|task|tasks)/**",
+    "**/_output/**",
+    "**/bower_components/**",
+    "**/build/**",
+    "**/dist/**",
+    "**/venv/**",
+    "**/node_modules/**",
+    "**/out/**",
+    "**/output/**",
+    "**/release/**",
+    "**/releases/**",
+    "**/static/**",
+    "**/target/**",
+    "**/third_party/**",
+    "**/vendor/**",
+    "**/coverage/**"
+  ],
+  "vitest.enable": true,
+  "vitest.showFailMessages": true,
+  "vitest.commandLine": "yarn test",
+  "todo.embedded.exclude": [
+    "**/esm/**",
+    "**/coverage/**",
+    "**/test/spec/issues*",
+    "**/.*",
+    "**/.*/**",
+    "**/_output/**",
+    "**/bower_components/**",
+    "**/build/**",
+    "**/dist/**",
+    "**/venv/**",
+    "**/node_modules/**",
+    "**/out/**",
+    "**/output/**",
+    "**/release/**",
+    "**/releases/**",
+    "**/static/**",
+    "**/target/**",
+    "**/third_party/**",
+    "**/vendor/**",
+    "**/CHANGELOG",
+    "**/CHANGELOG.*",
+    "**/*.min.*",
+    "**/*.map",
+    "**/*.{3ds,3g2,3gp,7z,a,aac,adp,ai,aif,aiff,alz,ape,apk,ar,arj,asf,au,avi,bak,baml,bh,bin,bk,bmp,btif,bz2,bzip2,cab,caf,cgm,class,cmx,cpio,cr2,csv,cur,dat,dcm,deb,dex,djvu,dll,dmg,dng,doc,docm,docx,dot,dotm,dra,DS_Store,dsk,dts,dtshd,dvb,dwg,dxf,ecelp4800,ecelp7470,ecelp9600,egg,eol,eot,epub,exe,f4v,fbs,fh,fla,flac,fli,flv,fpx,fst,fvt,g3,gif,graffle,gz,gzip,h261,h263,h264,icns,ico,ief,img,ipa,iso,jar,jpeg,jpg,jpgv,jpm,jxr,key,ktx,lha,lib,lvp,lz,lzh,lzma,lzo,m3u,m4a,m4v,mar,mdi,mht,mid,midi,mj2,mka,mkv,mmr,mng,mobi,mov,movie,mp3,mp4,mp4a,mpeg,mpg,mpga,mxu,nef,npx,numbers,o,oga,ogg,ogv,otf,pages,pbm,pcx,pdb,pdf,pea,pgm,pic,png,pnm,pot,potm,potx,ppa,ppam,ppm,pps,ppsm,ppsx,ppt,pptm,pptx,psd,pya,pyc,pyo,pyv,qt,rar,ras,raw,resources,rgb,rip,rlc,rmf,rmvb,rtf,rz,s3m,s7z,scpt,sgi,shar,sil,sketch,slk,smv,so,sub,swf,tar,tbz,tbz2,tga,tgz,thmx,tif,tiff,tlz,ttc,ttf,txz,udf,uvh,uvi,uvm,uvp,uvs,uvu,viv,vob,war,wav,wax,wbmp,wdp,weba,webm,webp,whl,wim,wm,wma,wmv,wmx,woff,woff2,wvx,xbm,xif,xla,xlam,xls,xlsb,xlsm,xlsx,xlt,xltm,xltx,xm,xmind,xpi,xpm,xwd,xz,z,zip,zipx}"
+  ],
+  "todo.embedded.providers.ag.args": "",
+  "todo.embedded.providers.ag.regex": "(?:#|// @|//|/\\*+|<!--|--|\\* @|\\{!|\\{\\{!--|\\{\\{!) *(TODO|FIXME|FIX|BUG|UGLY|HACK|IDEA|REVIEW|DEBUG|OPTIMIZE)",
+  "todo.embedded.providers.rg.regex": "(?:#|// @|//|/\\*+|<!--|--|\\* @|\\{!|\\{\\{!--|\\{\\{!) *(TODO|FIXME|FIX|BUG|UGLY|HACK|IDEA|REVIEW|DEBUG|OPTIMIZE)",
+  "todo.embedded.providers.rg.args": "",
+  "todo.embedded.provider": "javascript",
+  "files.exclude": {
+    "**/.directory": true,
+    "**/esm": true,
+    "**/node_modules": true
+  }
+}

CHANGELOG.md

@@ -1,3 +1,29 @@
+## Vuedoc Parser 4.0.0-beta10
+
+This release introduces Vuedoc Plugins and many other new features and
+improvements:
+
+**New features**
+
+- Introduce Vuedoc Plugins
+- Add support of Vue Mixins
+- Load imports automatically when needed
+- Add `options.resolver` used to resolve imports
+- Extensible Parsing with `options.composition`
+- Add `@vuedoc/parser/test-utils` for testing
+
+**Improvements**
+
+- Use `EventTarget` as base class for the main parser class. This help for a
+  better events handling and useful for preventing event propagation.
+- Improve parsing of variable declarations
+- Improve parsing performance by reducing internal instances
+- Improve documentation by adding more examples
+
+**Dependencies Changes***
+
+- Upgrade to `@babel/[email protected]`
+
 ## Vuedoc Parser 4.0.0-beta9
 
 This release fixes an ESM import bug and upgrades to @babel/parser@7.18.9.

CONTRIBUTING.md

@@ -37,6 +37,23 @@ Therefore:
   would have expected.
 * A detailed description of the behavior that you expect.
 
+## Development Setup
+
+1. [Install Nix Package Manager](https://nixos.org/manual/nix/stable/installation/installing-binary.html)
+
+2. [Install `direnv` with your OS package manager](https://direnv.net/docs/installation.html#from-system-packages)
+
+3. [Hook it `direnv` into your shell](https://direnv.net/docs/hook.html)
+
+4. At the top-level of your project run:
+
+   ```sh
+   direnv allow
+   ```
+
+   > The next time your launch your terminal and enter the top-level of your
+   > project, `direnv` will check for changes.
+
 ## Contribute
 
 Contributions to Vuedoc Parser are welcome. Here is how you can contribute: