add test; update README; bump to v0.1.1

Author: tomchen

.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+    branches:
+      - main
+      - master
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 4
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        node: [10.x, 12.x, 14.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install modules
+        run: yarn
+      - name: Run tests
+        run: yarn test

.gitignore

@@ -1,3 +1,5 @@
+test/docs
+test/docs2
 
 # Logs
 logs

README.md

@@ -4,6 +4,8 @@
 
 This [TypeDoc](https://typedoc.org/) plugin can force inclusion of specific symbols (variables) that are not exported, by making them fake exports.
 
+(Requires TypeDoc ≥ v0.20.16 (2021-01-17))
+
 ## Usage
 
 Install the plugin with [npm](https://www.npmjs.com/):
@@ -67,8 +69,6 @@ Or, if you are using `@internalDoNotUse` tag instead of `@notExported`, run:
 typedoc --includeTag internalDoNotUse src/index.ts
 ```
 
-That's it.
-
 ## Links, Tips & Others
 
 Originally from [here](https://github.com/TypeStrong/typedoc/issues/1474#issuecomment-766178261).

package.json

@@ -1,9 +1,14 @@
 {
   "name": "typedoc-plugin-not-exported",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "TypeDoc plugin that forces inclusion of non-exported symbols (variables)",
   "main": "src/main.js",
-  "scripts": {},
+  "scripts": {
+    "test": "npm run test:gen && npm run test:jest && npm run test:cleanup",
+    "test:cleanup": "rimraf test/docs test/docs2",
+    "test:gen": "npm run test:cleanup && typedoc --options test/typedoc.json && typedoc --options test/typedoc2.json",
+    "test:jest": "jest"
+  },
   "files": [
     "src"
   ],
@@ -13,11 +18,10 @@
     "plugin",
     "exported",
     "nonexported",
-    "include",
-    "plugin"
+    "include"
   ],
   "author": "Tom Chen <tomchen.org@gmail.com>",
-  "license": "CC0",
+  "license": "CC0-1.0",
   "homepage": "https://github.com/tomchen/typedoc-plugin-not-exported",
   "repository": {
     "type": "git",
@@ -27,12 +31,17 @@
     "url": "https://github.com/tomchen/typedoc-plugin-not-exported/issues"
   },
   "peerDependencies": {
-    "typedoc": ">=0.20.0"
+    "typedoc": ">=0.20.16"
   },
   "devDependencies": {
+    "cheerio": "^1.0.0-rc.5",
     "eslint": "^7.18.0",
     "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-prettier": "^3.3.1",
-    "prettier": "^2.2.1"
+    "jest": "^26.6.3",
+    "prettier": "^2.2.1",
+    "rimraf": "^3.0.2",
+    "typedoc": "0.20.16",
+    "typescript": "^4.1.3"
   }
 }

src/main.js

@@ -8,7 +8,7 @@
 
 //@ts-check
 
-const { Converter, TypeScript } = require('typedoc') // version 0.20.x
+const { Converter, TypeScript } = require('typedoc') // version 0.20.16+
 
 const ModuleFlags =
   TypeScript.SymbolFlags.ValueModule | TypeScript.SymbolFlags.NamespaceModule

test/docs.test.js

@@ -0,0 +1,60 @@
+const cheerio = require('cheerio')
+const fs = require('fs')
+
+const $ = cheerio.load(fs.readFileSync('./test/docs/index.html'))
+
+test('Cls', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section.tsd-panel-group.tsd-index-group > section > div > section:nth-child(1) > ul > li > a'
+    ).text()
+  ).toBe('Cls')
+})
+
+test('threeNumbers', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section.tsd-panel-group.tsd-index-group > section > div > section:nth-child(2) > ul > li:nth-child(1) > a'
+    ).text()
+  ).toBe('threeNumbers')
+})
+
+test('notexported tag', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section:nth-child(2) > section:nth-child(3) > div.tsd-comment.tsd-typography > dl > dt'
+    ).text()
+  ).toBe('notexported')
+})
+
+test('twonumbers href', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section:nth-child(2) > section:nth-child(4) > div > a:nth-child(4)'
+    ).attr('href')
+  ).toBe('index.html#twonumbers')
+})
+
+test('cls href', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section:nth-child(3) > section > div > a'
+    ).attr('href')
+  ).toBe('classes/cls.html')
+})
+
+test('class count', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section.tsd-panel-group.tsd-index-group > section > div > section:nth-child(1) > ul > li.tsd-kind-class'
+    ).length
+  ).toBe(1)
+})
+
+test('type count', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section.tsd-panel-group.tsd-index-group > section > div > section:nth-child(2) > ul > li.tsd-kind-type-alias'
+    ).length
+  ).toBe(3)
+})

test/docs2.test.js

@@ -0,0 +1,60 @@
+const cheerio = require('cheerio')
+const fs = require('fs')
+
+const $ = cheerio.load(fs.readFileSync('./test/docs2/index.html'))
+
+test('Cls', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section.tsd-panel-group.tsd-index-group > section > div > section:nth-child(1) > ul > li > a'
+    ).text()
+  ).toBe('Cls')
+})
+
+test('threeNumbers', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section.tsd-panel-group.tsd-index-group > section > div > section:nth-child(2) > ul > li:nth-child(1) > a'
+    ).text()
+  ).toBe('threeNumbers')
+})
+
+test('notexported tag', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section:nth-child(2) > section:nth-child(3) > div.tsd-comment.tsd-typography > dl > dt'
+    ).text()
+  ).toBe('internaldonotuse')
+})
+
+test('twonumbers href', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section:nth-child(2) > section:nth-child(4) > div > a:nth-child(4)'
+    ).attr('href')
+  ).toBe('index.html#twonumbers')
+})
+
+test('cls href', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section:nth-child(3) > section > div > a'
+    ).attr('href')
+  ).toBe('classes/cls.html')
+})
+
+test('class count', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section.tsd-panel-group.tsd-index-group > section > div > section:nth-child(1) > ul > li.tsd-kind-class'
+    ).length
+  ).toBe(1)
+})
+
+test('type count', () => {
+  expect(
+    $(
+      'body > div.container.container-main > div > div.col-8.col-content > section.tsd-panel-group.tsd-index-group > section > div > section:nth-child(2) > ul > li.tsd-kind-type-alias'
+    ).length
+  ).toBe(3)
+})

test/index.ts

@@ -0,0 +1,34 @@
+/**
+ * @notExported
+ */
+type twoNumbers = [number, number]
+/**
+ * @notExported
+ */
+type threeNumbers = [number, number, number]
+
+type fourNumbers = [number, number, number, number]
+
+export type twoOrThreeNumbers = twoNumbers | threeNumbers
+
+export function sum2(ns: twoOrThreeNumbers): number {
+  return ns.reduce((a, b) => a + b)
+}
+
+/**
+ * My class
+ * @notExported
+ */
+class Cls {
+  convert(str: string): string {
+    return str
+  }
+}
+
+class HiddenCls {
+  convert(str: string): string {
+    return str
+  }
+}
+
+export const me = new Cls()

test/index2.ts

@@ -0,0 +1,34 @@
+/**
+ * @internalDoNotUse
+ */
+type twoNumbers = [number, number]
+/**
+ * @internalDoNotUse
+ */
+type threeNumbers = [number, number, number]
+
+type fourNumbers = [number, number, number, number]
+
+export type twoOrThreeNumbers = twoNumbers | threeNumbers
+
+export function sum2(ns: twoOrThreeNumbers): number {
+  return ns.reduce((a, b) => a + b)
+}
+
+/**
+ * My class
+ * @internalDoNotUse
+ */
+class Cls {
+  convert(str: string): string {
+    return str
+  }
+}
+
+class HiddenCls {
+  convert(str: string): string {
+    return str
+  }
+}
+
+export const me = new Cls()

test/jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  roots: ['<rootDir>/test'],
+  testMatch: [
+    '**/__tests__/**/*.+js',
+    '**/?(*.)+(spec|test).+js',
+  ],
+}