feat(theme-demo): init package

Related to #109
KnodesCommunity · Jul 23, 2022 · 25e82d8 · 25e82d8
1 parent 86cb221
commit 25e82d8
Show file tree

Hide file tree

Showing 11 changed files with 327 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -125,6 +125,7 @@
     "typedoc": "^0.23.8",
     "typescript": "^4.7.4",
     "unionfs": "^4.4.0",
-    "yaml": "^2.1.1"
+    "yaml": "^2.1.1",
+    "@knodes/typedoc-theme-demo": "file:./packages/theme-demo"
   }
 }
diff --git a/packages/theme-demo/.eslintrc.js b/packages/theme-demo/.eslintrc.js
@@ -0,0 +1,8 @@
+module.exports = {
+	root: true,
+	extends: [ '@knodes/eslint-config/ts' ],
+	env: { node: true },
+	parserOptions: {
+		project: [ `${__dirname}/tsconfig.build.json`, `${__dirname}/tsconfig.spec.json` ],
+	},
+};
diff --git a/packages/theme-demo/.gitignore b/packages/theme-demo/.gitignore
@@ -0,0 +1 @@
+__tests__/mock-fs/**/docs
diff --git a/packages/theme-demo/CHANGELOG.md b/packages/theme-demo/CHANGELOG.md
@@ -0,0 +1,114 @@
+## [0.23.1](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.23.0...v0.23.1) (2022-07-19)
+
+
+No notable changes were done in this version.
+
+
+### Bug Fixes
+
+* **monorepo**: remove hacky MarkdownToSummary ([2edc787](https://github.com/KnodesCommunity/typedoc-plugins/commit/2edc78721cf5523b9cdd6d5a41290bb51e8dfed1)), closes [#130](https://github.com/KnodesCommunity/typedoc-plugins/issues/130) [TypeStrong/typedoc#2004](https://github.com/TypeStrong/typedoc/issues/2004)
+* **monorepo**: windows support ([47bf765](https://github.com/KnodesCommunity/typedoc-plugins/commit/47bf765ad8c892a2bfda00562f800438f4a268ad))
+
+
+# [0.23.0](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.7...v0.23.0) (2022-07-19)
+
+
+### Bug Fixes
+
+* **dep: @knodes/typedoc-pluginutils**: use correct Typedoc log methods for colors ([c02d8a](https://github.com/KnodesCommunity/typedoc-plugins/commit/c02d8a0dad05325005257537bdb405a847e875a5))
+* **dep: @knodes/typedoc-pluginutils**: avoid considering '.' files as relative paths ([c02d8a](https://github.com/KnodesCommunity/typedoc-plugins/commit/c02d8a0dad05325005257537bdb405a847e875a5))
+
+
+### Features
+
+* **dep: @knodes/typedoc-pluginutils**: add helper to create sources with repo URL ([d069278](https://github.com/KnodesCommunity/typedoc-plugins/commit/d069278d70398244a5bbf434b27b747c40ef5866))
+
+
+## [0.22.7](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.6...v0.22.7) (2022-06-29)
+
+
+No notable changes were done in this version.
+
+
+### Bug Fixes
+
+* **deps**: update dependency memfs to v3.4.7 ([f9acee2](https://github.com/KnodesCommunity/typedoc-plugins/commit/f9acee29c68c7525a95f40c0982b7b4981f69ab7))
+
+
+## [0.22.6](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.5...v0.22.6) (2022-06-27)
+
+
+No notable changes were done in this version.
+
+
+### Bug Fixes
+
+* **monorepo**: add lodash as a dependency ([6306880](https://github.com/KnodesCommunity/typedoc-plugins/commit/6306880f7c248e2ea1e94adf5bae396702db6661)), closes [#99](https://github.com/KnodesCommunity/typedoc-plugins/issues/99)
+* **build**: typedoc patcher truncate file on open ([cdb4fca](https://github.com/KnodesCommunity/typedoc-plugins/commit/cdb4fca980e6ab333498de1cb7c2f5d1880522d5))
+* **monorepo**: continue fixes for Windows scripts ([40f8d1d](https://github.com/KnodesCommunity/typedoc-plugins/commit/40f8d1d63bd54f6d68fb28d6a72f3be238799215))
+* **monorepo**: continue normalize behaviors between windows & non-windows ([c1803ef](https://github.com/KnodesCommunity/typedoc-plugins/commit/c1803ef30033890e5ee8dbb4f94868c15e1e3805))
+* **deps**: update dependency memfs to v3.4.3 ([445a9cc](https://github.com/KnodesCommunity/typedoc-plugins/commit/445a9cc2b588487dc34144130dcc0435e56a37f2))
+* **deps**: update dependency memfs to v3.4.4 ([2d83aa6](https://github.com/KnodesCommunity/typedoc-plugins/commit/2d83aa6758ed3f8cf8d32a0953aee641a3ee46df))
+* **monorepo**: normalize behavior between POSIX & Windows systems ([3ce9434](https://github.com/KnodesCommunity/typedoc-plugins/commit/3ce9434100e9e87d5af8a9dd6536a8ea93e5342c))
+
+
+## [0.22.5](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.4...v0.22.5) (2022-04-30)
+
+
+No notable changes were done in this version.
+
+
+### Bug Fixes
+
+* **deps**: update dependency semver to v7.3.7 ([42fbe4a](https://github.com/KnodesCommunity/typedoc-plugins/commit/42fbe4a60fd5e008c4d80bc269a4cc2e060c126a))
+
+
+## [0.22.4](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.3...v0.22.4) (2022-04-07)
+
+
+No notable changes were done in this version.
+
+
+## [0.22.3](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.2...v0.22.3) (2022-03-21)
+
+
+No notable changes were done in this version.
+
+
+## [0.22.2](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.1...v0.22.2) (2022-03-06)
+
+
+No notable changes were done in this version.
+
+
+## 0.22.1 (2022-03-04)
+
+
+No notable changes were done in this version.
+
+
+### Bug Fixes
+
+* **monorepo**: fix events order, bind TypeDoc prototypes to watch custom events ([83ee577](https://github.com/KnodesCommunity/typedoc-plugins/commit/83ee5776cea435fd4b5d155d1bd96f99737a5063))
+* **monorepo**: various reflection path resolution fixes, better test code blocks ([314f173](https://github.com/KnodesCommunity/typedoc-plugins/commit/314f173d5430f452a9924569db8f38575337c638))
+
+
+### Features
+
+* **dep: @knodes/typedoc-pluginutils**: add `name` getter on plugin ([335095a](https://github.com/KnodesCommunity/typedoc-plugins/commit/335095a976ecedab7d1cbb64a2a1de0e4e5e7b79))
+* **dep: @knodes/typedoc-pluginutils**: add better support for modules in path reflection resolution ([ff0f7c7](https://github.com/KnodesCommunity/typedoc-plugins/commit/ff0f7c790c627a8308c00c8d5426d402657d11fa))
+* **dep: @knodes/typedoc-pluginutils**: add option group, add resolvePackageFile ([878baf8](https://github.com/KnodesCommunity/typedoc-plugins/commit/878baf8f713cd1f307bcde2a909ae0257d835d73))
+* **dep: @knodes/typedoc-pluginutils**: add package ([f6894ad](https://github.com/KnodesCommunity/typedoc-plugins/commit/f6894ad003e7f4336407238bc6dea1fd4d9c9101))
+* **dep: @knodes/typedoc-pluginutils**: add PathReflectionResolver, add plugin.relativeToRoot, use in MarkdownReplacer ([40eb1a1](https://github.com/KnodesCommunity/typedoc-plugins/commit/40eb1a1c2dca89cae27625f4234316166c652706))
+* **dep: @knodes/typedoc-pluginutils**: add rootDir on plugin, add CurrentPageMemo, add MarkdownReplacer, improve Logger ([200f52f](https://github.com/KnodesCommunity/typedoc-plugins/commit/200f52f8417865734c19ed6bc8d91128a2902abe))
+* **dep: @knodes/typedoc-pluginutils**: add source map support in markdown replacer ([57e5e39](https://github.com/KnodesCommunity/typedoc-plugins/commit/57e5e3925725e58677038d9b2dc9943ac42b0c96))
+* **dep: @knodes/typedoc-pluginutils**: fix `wrapError`, add helper `catchWrap` ([350fc9b](https://github.com/KnodesCommunity/typedoc-plugins/commit/350fc9b9281fce5b7bd7c98253af4a4ef8f66d79))
+
+
+## 0.22.0 (2022-02-23)
+
+
+No notable changes were done in this version.
+
+
+## 0.0.1 (2022-02-23)
diff --git a/packages/theme-demo/README.md b/packages/theme-demo/README.md
@@ -0,0 +1,30 @@
+<!-- HEADER -->
+# @knodes/typedoc-theme-demo
+
+[![npm version](https://img.shields.io/npm/v/@knodes/typedoc-theme-demo?style=for-the-badge)](https://www.npmjs.com/package/@knodes/typedoc-theme-demo)
+[![npm downloads](https://img.shields.io/npm/dm/@knodes/typedoc-theme-demo?style=for-the-badge)](https://www.npmjs.com/package/@knodes/typedoc-theme-demo)
+[![Compatible with TypeDoc](https://img.shields.io/badge/For%20typedoc-^0.23.0-green?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/typedoc)
+
+---
+
+[![CircleCI](https://img.shields.io/circleci/build/github/KnodesCommunity/typedoc-plugins/main?style=for-the-badge)](https://circleci.com/gh/KnodesCommunity/typedoc-plugins/tree/main)
+[![Code Climate coverage](https://img.shields.io/codeclimate/coverage-letter/KnodesCommunity/typedoc-plugins?style=for-the-badge)](https://codeclimate.com/github/KnodesCommunity/typedoc-plugins)
+[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/KnodesCommunity/typedoc-plugins?style=for-the-badge)](https://codeclimate.com/github/KnodesCommunity/typedoc-plugins)
+
+For more infos, please refer to [the documentation](https://knodescommunity.github.io/typedoc-plugins/modules/_knodes_typedoc_theme_demo.html)
+<!-- HEADER end -->
+
+
+<!-- INSTALL -->
+## Quick start
+
+```sh
+npm install --save-dev @knodes/typedoc-theme-demo typedoc@^0.23.0
+```
+
+## Compatibility
+
+This plugin version should match TypeDoc `^0.23.0` for compatibility.
+
+> **Note**: this plugin version was released by testing against `^0.23.8`.
+<!-- INSTALL end -->
diff --git a/packages/theme-demo/__tests__/integration/.keep b/packages/theme-demo/__tests__/integration/.keep
diff --git a/packages/theme-demo/jest.config.js b/packages/theme-demo/jest.config.js
@@ -0,0 +1,12 @@
+const base = require( '../../jest.config.base' )( __dirname );
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+	...base,
+	projects: [
+		base.projects[0],
+		{
+			...base.projects[1],
+			setupFilesAfterEnv: [ ...base.projects[1].setupFilesAfterEnv, '@testing-library/jest-dom' ],
+		},
+	],
+};
diff --git a/packages/theme-demo/package.json b/packages/theme-demo/package.json
@@ -0,0 +1,64 @@
+{
+  "name": "@knodes/typedoc-theme-demo",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KnodesCommunity/typedoc-plugins.git"
+  },
+  "bugs": {
+    "url": "https://github.com/KnodesCommunity/typedoc-plugins/issues"
+  },
+  "homepage": "https://knodescommunity.github.io/typedoc-plugins/modules/_knodes_typedoc_theme_demo.html",
+  "author": {
+    "email": "[email protected]",
+    "name": "GerkinDev"
+  },
+  "keywords": [
+    "documentation",
+    "typedoc"
+  ],
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "build:clean": "rimraf dist",
+    "lint": "eslint --ignore-path ../../.eslintignore '**/?(.)*.?([cm])[tj]s?(x)'",
+    "prepublishOnly": "npm run build:clean && npm run build",
+    "test": "jest --config jest.config.js"
+  },
+  "dependencies": {
+    "lodash": "^4.17.21",
+    "@knodes/typedoc-pluginutils": "~0.23.1"
+  },
+  "peerDependencies": {
+    "typedoc": "^0.23.0"
+  },
+  "devDependencies": {
+    "@knodes/eslint-config": "^1.6.5",
+    "@testing-library/jest-dom": "^5.16.4",
+    "@types/jest": "^28.1.6",
+    "@types/jsdom": "^16.2.14",
+    "@types/lodash": "^4.14.182",
+    "@types/node": "^18.0.0",
+    "@types/react": "^18.0.14",
+    "@typescript-eslint/eslint-plugin": "^5.28.0",
+    "@typescript-eslint/parser": "^5.28.0",
+    "eslint": "^8.18.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsdoc": "^39.3.3",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-sort-export-all": "^1.2.2",
+    "jest": "^28.1.1",
+    "jest-extended": "^3.0.1",
+    "jest-junit": "^14.0.0",
+    "jsdom": "^19.0.0",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^28.0.5",
+    "typedoc": "^0.23.8",
+    "typescript": "^4.7.4"
+  }
+}
diff --git a/packages/theme-demo/src/index.ts b/packages/theme-demo/src/index.ts
@@ -0,0 +1 @@
+export const STUB = '';
diff --git a/packages/theme-demo/tsconfig.build.json b/packages/theme-demo/tsconfig.build.json
@@ -0,0 +1,78 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    "incremental": true,                            /* Enable incremental compilation */
+    // "target": "es6",                             /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
+    // "module": "commonjs",                        /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                                   /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                             /* Allow javascript files to be compiled. */
+    // "checkJs": true,                             /* Report errors in .js files. */
+    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    // "outFile": "./",                             /* Concatenate and emit output to single file. */
+    "outDir": "./dist",                             /* Redirect output structure to the directory. */
+    "rootDir": "./src",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                           /* Enable project compilation */
+    "tsBuildInfoFile": "./dist/tsconfig.tsbuildinfo", /* Specify file to store incremental compilation information */
+    // "removeComments": true,                      /* Do not emit comments to output. */
+    // "noEmit": true,                              /* Do not emit outputs. */
+    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    // "strict": true,                              /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                    /* Enable strict null checks. */
+    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
+    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+    "paths": {
+      "#plugintestbed": ["packages/plugintestbed"],
+      "@knodes/typedoc-*": ["packages/*"],
+    },                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                             /* List of folders to include type definitions from. */
+    // "types": [],                                 /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    // "esModuleInterop": true,                     /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    // "skipLibCheck": true,                        /* Skip type checking of declaration files. */
+    // "forceConsistentCasingInFileNames": true,       /* Disaw inconsistently-cased references to the same file. */
+  },
+  "include": ["src", "types/src.d.ts"],
+  "exclude": ["**/*.spec.ts"]
+}
diff --git a/packages/theme-demo/tsconfig.spec.json b/packages/theme-demo/tsconfig.spec.json
@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "types": [
+      "jest",
+      "jest-extended",
+      "@testing-library/jest-dom",
+      "node"
+    ],
+    "paths": {
+      "#plugintestbed": ["packages/plugintestbed/src"],
+      "@knodes/typedoc-*": ["packages/*/src"],
+    }
+  },
+  "include": ["src", "__tests__", "types/test.d.ts"],
+  "exclude": []
+}