Fix eslint issues

Author: demsking

.gitlab-ci.yml

@@ -52,7 +52,7 @@ pages:
   dependencies:
     - tests & coverage
   script:
-    - mv coverage/lcov-report/ public/
+    - mv coverage/ public/
   artifacts:
     paths:
       - public
@@ -63,13 +63,12 @@ pages:
     name: coverage report
     url: https://vuedoc.gitlab.io/parser
 
-package:
-  stage: publish
+build:
+  stage: tests
   needs: *security-jobs
   script:
     - yarn install
     - yarn build
-    - yarn pack
   artifacts:
     paths:
       - ./*.tgz
@@ -83,7 +82,6 @@ publish:
   script:
     - echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > .npmrc
     - yarn install
-    - yarn build
     - yarn publish
   environment:
     name: npm

.npmignore

@@ -3,7 +3,7 @@ test
 coverage
 .*
 sample.js
-vitest.ts
+vitest.config.ts
 result.json
 tsconfig.json
 *.tgz

package.json

@@ -6,22 +6,22 @@
   "exports": {
     ".": "./esm/index.js",
     "./types": "./types/index.d.ts",
-    "./Enum": "./esm/lib/Enum.js",
-    "./entity/ComputedEntry": "./esm/lib/entity/ComputedEntry.js",
-    "./entity/DataEntry": "./esm/lib/entity/DataEntry.js",
-    "./entity/DescriptionEntry": "./esm/lib/entity/DescriptionEntry.js",
-    "./entity/EventEntry": "./esm/lib/entity/EventEntry.js",
-    "./entity/InheritAttrsEntry": "./esm/lib/entity/InheritAttrsEntry.js",
-    "./entity/Keyword": "./esm/lib/entity/Keyword.js",
-    "./entity/KeywordsEntry": "./esm/lib/entity/KeywordsEntry.js",
-    "./entity/MethodEntry": "./esm/lib/entity/MethodEntry.js",
-    "./entity/ModelEntry": "./esm/lib/entity/ModelEntry.js",
-    "./entity/NameEntry": "./esm/lib/entity/NameEntry.js",
-    "./entity/PropEntry": "./esm/lib/entity/PropEntry.js",
+    "./enum": "./esm/lib/Enum.js",
+    "./entity/computed": "./esm/lib/entity/ComputedEntry.js",
+    "./entity/data": "./esm/lib/entity/DataEntry.js",
+    "./entity/description": "./esm/lib/entity/DescriptionEntry.js",
+    "./entity/event": "./esm/lib/entity/EventEntry.js",
+    "./entity/inheritAttrs": "./esm/lib/entity/InheritAttrsEntry.js",
+    "./entity/keyword": "./esm/lib/entity/Keyword.js",
+    "./entity/keywords": "./esm/lib/entity/KeywordsEntry.js",
+    "./entity/method": "./esm/lib/entity/MethodEntry.js",
+    "./entity/model": "./esm/lib/entity/ModelEntry.js",
+    "./entity/name": "./esm/lib/entity/NameEntry.js",
+    "./entity/prop": "./esm/lib/entity/PropEntry.js",
     "./entity/RestValue": "./esm/lib/entity/RestValue.js",
-    "./entity/SlotEntry": "./esm/lib/entity/SlotEntry.js",
-    "./entity/Value": "./esm/lib/entity/Value.js",
-    "./JSDoc": "./esm/lib/JSDoc.js",
+    "./entity/slot": "./esm/lib/entity/SlotEntry.js",
+    "./entity/value": "./esm/lib/entity/Value.js",
+    "./jsdoc": "./esm/lib/JSDoc.js",
     "./loaders/html": "./esm/loaders/html.js",
     "./loaders/javascript": "./esm/loaders/javascript.js",
     "./loaders/pug": "./esm/loaders/pug.js",
@@ -34,10 +34,11 @@
   "scripts": {
     "preversion": "yarn test",
     "build": "tsc",
+    "prepack": "yarn build",
     "test": "vitest",
     "testui": "vitest --ui",
     "coverage": "vitest run --coverage",
-    "update-examples": "UPDATE_EXAMPLES_RESULTS=true node_modules/.bin/vitest -- Compatibility.spec.js",
+    "update-examples": "UPDATE_EXAMPLES_RESULTS=true node_modules/.bin/vitest --run Compatibility.spec.js",
     "lint": "eslint .",
     "gimtoc": "gimtoc -f README.md -s 'Table of Contents' -o README.md"
   },

src/index.ts

@@ -1,5 +1,6 @@
-import path from 'path';
+import path from 'node:path';
 
+import { readFile } from 'node:fs/promises';
 import { Loader, Options } from './lib/Loader.js';
 import { Parser } from './lib/parser/Parser.js';
 import { VueLoader } from './loaders/vue.js';
@@ -34,7 +35,7 @@ export async function parseOptions(options: Vuedoc.Index.Options) {
 
   if ('filename' in options) {
     if (options.filename) {
-      filecontent = await Loader.getFileContent(options.filename, options.encoding);
+      filecontent = await readFile(options.filename, options.encoding as 'utf8');
     } else {
       throw new Error('options.filename cannot be empty');
     }

src/lib/Loader.ts

@@ -1,4 +1,3 @@
-import { readFile } from 'node:fs/promises';
 import { Vuedoc } from '../../types/index.js';
 
 export type Options = Pick<Vuedoc.Parser.ResolvedOptions, 'source'> & {
@@ -22,12 +21,6 @@ export abstract class Loader implements Vuedoc.Loader.Interface {
     return item.loader;
   }
 
-  static async getFileContent(filename: string, encoding?: string) {
-    const buffer = await readFile(filename, encoding as any);
-
-    return buffer.toString();
-  }
-
   constructor(options: Options) {
     this.options = options;
   }

src/lib/parser/ScriptParser.ts

@@ -96,12 +96,9 @@ export type Options = {
 };
 
 export class ScriptParser<ParseNode = void, Root = never> extends AbstractSourceParser<Vuedoc.Parser.Script, Root> {
-  source: Vuedoc.Parser.Script;
   options: Options;
   ast: Vuedoc.Parser.AST.Result;
   ignoredMothods: never[];
-  features: Vuedoc.Parser.Feature[];
-  scope: Vuedoc.Parser.Scope<any, any>;
   defaultModelPropName = 'value';
 
   constructor(emitter: Parser, ast: Vuedoc.Parser.AST.Result, source: Vuedoc.Parser.Script, options: Options) {

test/examples/temperature-converter/parsing-result.json

@@ -43,8 +43,8 @@
         {
           "name": "v",
           "type": "unknown",
-          "defaultValue": "+e.target.value",
-          "rest": false
+          "rest": false,
+          "defaultValue": "+e.target.value"
         }
       ],
       "syntax": [
@@ -68,8 +68,8 @@
         {
           "name": "v",
           "type": "unknown",
-          "defaultValue": "+e.target.value",
-          "rest": false
+          "rest": false,
+          "defaultValue": "+e.target.value"
         }
       ],
       "syntax": [

tsconfig.json

@@ -1,8 +1,8 @@
 {
   "compilerOptions": {
     "allowJs": false,
-    "target": "ES2019",
-    "module": "NodeNext",
+    "target": "ES2020",
+    "module": "ES2020",
     "strict": false,
     "importHelpers": true,
     "moduleResolution": "node",
@@ -19,9 +19,6 @@
     "types": [
       "node"
     ],
-    "lib": [
-      "ES2019"
-    ],
     "typeRoots": [
       "node_modules/@types"
     ]

types/index.d.ts

@@ -7,6 +7,9 @@ import { Value } from '../src/lib/entity/Value.js';
 
 import * as Babel from '@babel/types';
 
+export { Loader } from './lib/Loader.js';
+export { Parser } from './lib/parser/Parser.js';
+
 export declare namespace Vuedoc {
   namespace Parser {
     type Options = {
@@ -365,10 +368,6 @@ export declare namespace Vuedoc {
 
     type Options = (PartialFilenameOptions | PartialFilecontentOptions) & BasicOptions;
 
-    function parseComponent(options: Options): Promise<ParsingResult>;
-    function parseOptions(options: Options): Promise<void>;
-    function synchronizeParsingResult(options: Options, component: ParsingResult): void;
-
     type ParsingResult = {
       name?: string;
       description?: string;
@@ -391,8 +390,6 @@ export declare namespace Vuedoc {
   namespace Loader {
     abstract class Interface {
       static extend(name: LoaderName, loader: Interface): Definition;
-      static getFileContent(filename: string, options?: GetFileContentOptions): Promise<string>;
-
       abstract load(data: ScriptData | TemplateData): Promise<void>;
       emitTemplate(data: TemplateData): void;
       emitScript(data: ScriptData): void;
@@ -413,12 +410,12 @@ export declare namespace Vuedoc {
       name: LoaderName;
       loader: Interface;
     };
-
-    type GetFileContentOptions = {
-      /**
-       * The file encoding
-       */
-      encoding?: string;
-    };
   }
 }
+
+export declare function parseOptions(options: Vuedoc.Index.Options): Promise<Vuedoc.Parser.ResolvedOptions>;
+declare type ExtendedParsingResult = Vuedoc.Index.ParsingResult & {
+    model?: Vuedoc.Entry.ModelEntry[];
+};
+export declare function synchronizeParsingResult(options: Vuedoc.Index.Options, component: ExtendedParsingResult): void;
+export declare function parseComponent(options: Vuedoc.Index.Options): Promise<Vuedoc.Index.ParsingResult>;

vitest.config.ts

@@ -5,6 +5,7 @@ export default defineConfig({
   test: {
     watchExclude: [
       'test/examples/**',
+      'esm/**',
     ],
     passWithNoTests: true,
   },