fix: build errors (#104)

Author: kazupon

.eslintrc.js

@@ -8,14 +8,12 @@ module.exports = {
     jest: true
   },
   extends: [
-    'plugin:vue-libs/recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:@typescript-eslint/eslint-recommended',
-    'prettier',
-    'plugin:prettier/recommended'
+    'plugin:prettier/recommended',
+    'prettier'
   ],
   plugins: ['@typescript-eslint'],
-  parser: 'vue-eslint-parser',
   parserOptions: {
     parser: '@typescript-eslint/parser',
     sourceType: 'module'

.github/workflows/lint.yml

@@ -0,0 +1,37 @@
+name: Lint
+on:
+  push:
+    branches-ignore:
+      - gh-pages
+  pull_request:
+    branches-ignore:
+      - gh-pages
+    types:
+      - opened
+      - synchronize
+      - reopened
+permissions:
+  contents: read
+env:
+  CI: true
+
+jobs:
+  lint:
+    name: 'Lint'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.0.1
+        with:
+          version: 6.20.0
+      - name: Setup Node.js v14.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          cache: 'pnpm'
+      - name: Install
+        run: pnpm install
+      - name: Lint
+        run: pnpm lint

.github/workflows/test.yml

@@ -9,20 +9,25 @@ env:
 
 jobs:
   test:
-    name: "Test on Node.js ${{ matrix.node }} OS: ${{matrix.os}}"
+    name: 'Test on Node.js ${{ matrix.node }} OS: ${{matrix.os}}'
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [12, 14]
+        node: [12, 14, 16]
     steps:
       - name: Checkout
         uses: actions/checkout@v2
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.0.1
+        with:
+          version: 6.17.0
       - name: Setup Node.js ${{ matrix.node }}
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
+          cache: 'pnpm'
       - name: Install
-        run: yarn install
+        run: pnpm install
       - name: Test
-        run: yarn test
+        run: pnpm test

README.md

@@ -1,17 +1,17 @@
-# :book: api-docs-gen
+# 📔 api-docs-gen
 
 ![Test](https://github.com/kazupon/api-docs-gen/workflows/Test/badge.svg)
 [![npm](https://img.shields.io/npm/v/api-docs-gen.svg)](https://www.npmjs.com/package/api-docs-gen)
 
 API Documentation generator from `api-extractor` doc model
 
 
-## :hammer: Requirement
+## 🔨 Requirement
 
 You need to generate **doc model** with using [`api-extractor`](https://api-extractor.com/)
 
 
-## :cd: Installation
+## 💿 Installation
 
 ### npm
 
@@ -24,8 +24,13 @@ $ npm install -g api-docs-gen
 yarn global api-docs-gen
 ```
 
+### pnpm
+```sh
+pnpm add -g api-docs-gen
+```
 
-## :rocket: Usage
+
+## 🚀 Usage
 
 ### CLI
 ```
@@ -42,7 +47,7 @@ Options
 ```
 
 
-### API
+### 🤝 API
 ```javascript
 const path = require('path')
 const { genereate, DefaultConfig } = require('api-docs-gen')
@@ -60,24 +65,22 @@ await generate(input, output, { style: 'prefix', config: DefaultConfig })
 About details, See the [API References](https://github.com/kazupon/api-docs-gen/blob/master/api-docs-gen-api.md)
 
 
-## :lollipop: Examples
+## 🍭 Examples
 You can play API docs generation that have [multi packages](https://github.com/kazupon/api-docs-gen/tree/master/examples/packages).
 
 You can play with the following command:
 
 ```sh
-$ yarn example:setup # module installing on each package
-
-$ yarn example:build # build on each package
+$ pnpm example:build # build on each package
 
-$ yarn example:extract # generate doc model with `api-extractor` on each package
+$ pnpm example:extract # generate doc model with `api-extractor` on each package
 
-$ yarn example:gen # genearte API docs with `api-docs-gen`
+$ pnpm example:gen # genearte API docs with `api-docs-gen`
 
-$ yarn example:docs # run vuepress
+$ pnpm example:docs # run vuepress
 ```
 
-## :bookmark: TSDoc custom tags
+## 🔖 TSDoc custom tags
 
 `api-docs-gen` allows TSDoc custom tags to be processed using [tsdoc-config](https://github.com/microsoft/tsdoc/tree/master/tsdoc-config).
 
@@ -93,7 +96,7 @@ For the `MarkdownProcessor`, see the [API References](https://github.com/kazupon
 
 See how to configure it in the following configration.
 
-## :wrench: Configration
+## 🔧 Configration
 You can fully customize the generation of api docs using the config offered by `api-docs-gen`.
 
 Here is the schema (typescript type definition) of the config:
@@ -120,16 +123,16 @@ If you want to customize your api docs, these will be helpful.
 It's recommended to refer to the [API References](https://github.com/kazupon/api-docs-gen/blob/master/api-docs-gen-api.md) for customization.
 
 
-## :scroll: Changelog
+## 📜 Changelog
 Details changes for each release are documented in the [CHANGELOG.md](https://github.com/kazupon/api-docs-gen/blob/master/CHANGELOG.md).
 
 
-## :exclamation: Issues
+## ❗ Issues
 Please make sure to read the [Issue Reporting Checklist](https://github.com/kazupon/api-docs-gen/blob/master/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
 
-## :white_check_mark: TODO
+## ✅ TODO
 Managed with [GitHub Projects](https://github.com/kazupon/api-docs-gen/projects/2)
 
-## :copyright: License
+## ©️ License
 
 [MIT](http://opensource.org/licenses/MIT)

api-docs-gen-api.md

@@ -40,9 +40,6 @@ export interface Config
 ```
 
 
-#### Methods
-
-
 #### Properties
 
 ##### linkReferencer
@@ -186,9 +183,6 @@ export interface ContentBuilderOptions
 options that creating a [ContentBuilder](#contentbuilder)
 
 
-#### Methods
-
-
 #### Properties
 
 ##### indentLevel
@@ -211,9 +205,6 @@ export interface GenerateOptions
 ```
 
 
-#### Methods
-
-
 #### Properties
 
 ##### config
@@ -292,9 +283,6 @@ export interface MarkdownContent
 ```
 
 
-#### Methods
-
-
 #### Properties
 
 ##### body

lerna.json

@@ -27,36 +27,33 @@
     }
   },
   "dependencies": {
+    "@intlify/shared": "latest",
     "@microsoft/api-extractor-model": "^7.12.0",
     "@microsoft/tsdoc": "^0.13.0",
     "@microsoft/tsdoc-config": "^0.15.0",
     "chalk": "^4.1.1",
-    "debug": "^4.3.1",
-    "meow": "^10.0.0"
+    "debug": "^4.3.3",
+    "meow": "^9.0.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.12.0",
+    "@kazupon/lerna-changelog": "^4.3.0",
+    "@microsoft/api-extractor": "^7.18.21",
     "@types/debug": "^4.1.5",
     "@types/jest": "^26.0.23",
-    "@types/meow": "^6.0.0",
-    "@types/node": "^15.3.1",
-    "@typescript-eslint/eslint-plugin": "^4.24.0",
-    "@typescript-eslint/parser": "^4.24.0",
-    "eslint": "^7.26.0",
+    "@types/node": "^16.11.0",
+    "@typescript-eslint/eslint-plugin": "^5.5.0",
+    "@typescript-eslint/parser": "^5.5.0",
+    "eslint": "^8.4.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "eslint-plugin-vue-libs": "^4.0.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "jest": "^27.0.0",
     "jest-watch-typeahead": "^0.6.3",
-    "lerna": "^4.0.0",
-    "lerna-changelog": "^1.0.1",
     "npm-run-all": "^4.1.5",
     "opener": "^1.5.2",
-    "prettier": "^2.3.0",
+    "prettier": "^2.5.0",
     "shipjs": "^0.24.0",
     "ts-jest": "^27.0.0",
-    "typescript": "^4.2.4",
-    "typescript-eslint-language-service": "^4.1.4",
+    "typescript": "^4.5.2",
     "vuepress": "^1.8.2"
   },
   "engines": {
@@ -86,12 +83,18 @@
   ],
   "license": "MIT",
   "main": "lib/index.js",
+  "pnpm": {
+    "overrides": {
+      "typescript": "^4.5.2",
+      "@microsoft/api-extractor": "^7.18.21"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kazupon/api-docs-gen.git"
   },
   "scripts": {
-    "build": "yarn build:transpile && yarn build:extract",
+    "build": "pnpm build:transpile && pnpm build:extract",
     "build:docs": "node ./bin/run.js ./temp/api-docs-gen.api.json -c ./docsgen.config.js -o ./",
     "build:extract": "api-extractor run -l -c ./api-extractor.json",
     "build:transpile": "tsc -p .",
@@ -101,23 +104,22 @@
     "clean:extract": "rm -rf ./temp ./dist ./ect/*.md",
     "clean:lib": "rm -rf ./lib/*.*",
     "coverage": "opener coverage/lcov-report/index.html",
-    "example": "yarn example:build && yarn example:extract && yarn example:gen",
-    "example:build": "lerna run build",
-    "example:clean": "lerna run clean && rm -rf examples/docs/api/*.md",
+    "example": "pnpm example:build && pnpm example:extract && pnpm example:gen",
+    "example:build": "pnpm build --filter ./examples/packages",
+    "example:clean": "pnpm clean --filter ./examples/packages && rm -rf examples/docs/api/*.md",
     "example:docs": "vuepress dev examples/docs",
-    "example:extract": "lerna run extract",
+    "example:extract": "pnpm extract --filter ./examples/packages",
     "example:gen": "node ./bin/run.js ./examples/packages/utilities/temp/utilities.api.json ./examples/packages/library1/temp/library1.api.json -o ./examples/docs/api",
-    "example:setup": "lerna bootstrap",
     "example:teardown": "rm -rf ./examples/packages/utilities/node_modules && rm -rf ./examples/packages/library1/node_modules",
-    "fix": "npm-run-all --parallel lint:fix format:fix",
+    "fix": "run-p \"lint:fix\" \"format:fix\"",
     "format": "prettier --config .prettierrc --ignore-path .prettierignore '**/*.{js,json,html}'",
-    "format:fix": "yarn format --write",
+    "format:fix": "pnpm format -- --write",
     "lint": "eslint ./src ./test --ext .ts",
-    "lint:fix": "yarn lint --fix",
+    "lint:fix": "pnpm lint -- --fix",
     "release:prepare": "shipjs prepare",
     "release:trigger": "shipjs trigger",
-    "test": "yarn lint && yarn test:cover",
-    "test:cover": "yarn test:unit --coverage",
+    "test": "pnpm lint && pnpm test:cover",
+    "test:cover": "pnpm test:unit -- --coverage",
     "test:unit": "jest --env node",
     "test:watch": "jest --env node --watch",
     "watch": "tsc -p . --watch"