Skip to content

Commit 25e82d8

Browse files
committed
feat(theme-demo): init package
Related to #109
1 parent 86cb221 commit 25e82d8

File tree

11 files changed

+327
-1
lines changed

11 files changed

+327
-1
lines changed

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@
125125
"typedoc": "^0.23.8",
126126
"typescript": "^4.7.4",
127127
"unionfs": "^4.4.0",
128-
"yaml": "^2.1.1"
128+
"yaml": "^2.1.1",
129+
"@knodes/typedoc-theme-demo": "file:./packages/theme-demo"
129130
}
130131
}

packages/theme-demo/.eslintrc.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
root: true,
3+
extends: [ '@knodes/eslint-config/ts' ],
4+
env: { node: true },
5+
parserOptions: {
6+
project: [ `${__dirname}/tsconfig.build.json`, `${__dirname}/tsconfig.spec.json` ],
7+
},
8+
};

packages/theme-demo/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__tests__/mock-fs/**/docs

packages/theme-demo/CHANGELOG.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
## [0.23.1](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.23.0...v0.23.1) (2022-07-19)
2+
3+
4+
No notable changes were done in this version.
5+
6+
7+
### Bug Fixes
8+
9+
* **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)
10+
* **monorepo**: windows support ([47bf765](https://github.com/KnodesCommunity/typedoc-plugins/commit/47bf765ad8c892a2bfda00562f800438f4a268ad))
11+
12+
13+
# [0.23.0](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.7...v0.23.0) (2022-07-19)
14+
15+
16+
### Bug Fixes
17+
18+
* **dep: @knodes/typedoc-pluginutils**: use correct Typedoc log methods for colors ([c02d8a](https://github.com/KnodesCommunity/typedoc-plugins/commit/c02d8a0dad05325005257537bdb405a847e875a5))
19+
* **dep: @knodes/typedoc-pluginutils**: avoid considering '.' files as relative paths ([c02d8a](https://github.com/KnodesCommunity/typedoc-plugins/commit/c02d8a0dad05325005257537bdb405a847e875a5))
20+
21+
22+
### Features
23+
24+
* **dep: @knodes/typedoc-pluginutils**: add helper to create sources with repo URL ([d069278](https://github.com/KnodesCommunity/typedoc-plugins/commit/d069278d70398244a5bbf434b27b747c40ef5866))
25+
26+
27+
## [0.22.7](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.6...v0.22.7) (2022-06-29)
28+
29+
30+
No notable changes were done in this version.
31+
32+
33+
### Bug Fixes
34+
35+
* **deps**: update dependency memfs to v3.4.7 ([f9acee2](https://github.com/KnodesCommunity/typedoc-plugins/commit/f9acee29c68c7525a95f40c0982b7b4981f69ab7))
36+
37+
38+
## [0.22.6](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.5...v0.22.6) (2022-06-27)
39+
40+
41+
No notable changes were done in this version.
42+
43+
44+
### Bug Fixes
45+
46+
* **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)
47+
* **build**: typedoc patcher truncate file on open ([cdb4fca](https://github.com/KnodesCommunity/typedoc-plugins/commit/cdb4fca980e6ab333498de1cb7c2f5d1880522d5))
48+
* **monorepo**: continue fixes for Windows scripts ([40f8d1d](https://github.com/KnodesCommunity/typedoc-plugins/commit/40f8d1d63bd54f6d68fb28d6a72f3be238799215))
49+
* **monorepo**: continue normalize behaviors between windows & non-windows ([c1803ef](https://github.com/KnodesCommunity/typedoc-plugins/commit/c1803ef30033890e5ee8dbb4f94868c15e1e3805))
50+
* **deps**: update dependency memfs to v3.4.3 ([445a9cc](https://github.com/KnodesCommunity/typedoc-plugins/commit/445a9cc2b588487dc34144130dcc0435e56a37f2))
51+
* **deps**: update dependency memfs to v3.4.4 ([2d83aa6](https://github.com/KnodesCommunity/typedoc-plugins/commit/2d83aa6758ed3f8cf8d32a0953aee641a3ee46df))
52+
* **monorepo**: normalize behavior between POSIX & Windows systems ([3ce9434](https://github.com/KnodesCommunity/typedoc-plugins/commit/3ce9434100e9e87d5af8a9dd6536a8ea93e5342c))
53+
54+
55+
## [0.22.5](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.4...v0.22.5) (2022-04-30)
56+
57+
58+
No notable changes were done in this version.
59+
60+
61+
### Bug Fixes
62+
63+
* **deps**: update dependency semver to v7.3.7 ([42fbe4a](https://github.com/KnodesCommunity/typedoc-plugins/commit/42fbe4a60fd5e008c4d80bc269a4cc2e060c126a))
64+
65+
66+
## [0.22.4](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.3...v0.22.4) (2022-04-07)
67+
68+
69+
No notable changes were done in this version.
70+
71+
72+
## [0.22.3](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.2...v0.22.3) (2022-03-21)
73+
74+
75+
No notable changes were done in this version.
76+
77+
78+
## [0.22.2](https://github.com/KnodesCommunity/typedoc-plugins/compare/v0.22.1...v0.22.2) (2022-03-06)
79+
80+
81+
No notable changes were done in this version.
82+
83+
84+
## 0.22.1 (2022-03-04)
85+
86+
87+
No notable changes were done in this version.
88+
89+
90+
### Bug Fixes
91+
92+
* **monorepo**: fix events order, bind TypeDoc prototypes to watch custom events ([83ee577](https://github.com/KnodesCommunity/typedoc-plugins/commit/83ee5776cea435fd4b5d155d1bd96f99737a5063))
93+
* **monorepo**: various reflection path resolution fixes, better test code blocks ([314f173](https://github.com/KnodesCommunity/typedoc-plugins/commit/314f173d5430f452a9924569db8f38575337c638))
94+
95+
96+
### Features
97+
98+
* **dep: @knodes/typedoc-pluginutils**: add `name` getter on plugin ([335095a](https://github.com/KnodesCommunity/typedoc-plugins/commit/335095a976ecedab7d1cbb64a2a1de0e4e5e7b79))
99+
* **dep: @knodes/typedoc-pluginutils**: add better support for modules in path reflection resolution ([ff0f7c7](https://github.com/KnodesCommunity/typedoc-plugins/commit/ff0f7c790c627a8308c00c8d5426d402657d11fa))
100+
* **dep: @knodes/typedoc-pluginutils**: add option group, add resolvePackageFile ([878baf8](https://github.com/KnodesCommunity/typedoc-plugins/commit/878baf8f713cd1f307bcde2a909ae0257d835d73))
101+
* **dep: @knodes/typedoc-pluginutils**: add package ([f6894ad](https://github.com/KnodesCommunity/typedoc-plugins/commit/f6894ad003e7f4336407238bc6dea1fd4d9c9101))
102+
* **dep: @knodes/typedoc-pluginutils**: add PathReflectionResolver, add plugin.relativeToRoot, use in MarkdownReplacer ([40eb1a1](https://github.com/KnodesCommunity/typedoc-plugins/commit/40eb1a1c2dca89cae27625f4234316166c652706))
103+
* **dep: @knodes/typedoc-pluginutils**: add rootDir on plugin, add CurrentPageMemo, add MarkdownReplacer, improve Logger ([200f52f](https://github.com/KnodesCommunity/typedoc-plugins/commit/200f52f8417865734c19ed6bc8d91128a2902abe))
104+
* **dep: @knodes/typedoc-pluginutils**: add source map support in markdown replacer ([57e5e39](https://github.com/KnodesCommunity/typedoc-plugins/commit/57e5e3925725e58677038d9b2dc9943ac42b0c96))
105+
* **dep: @knodes/typedoc-pluginutils**: fix `wrapError`, add helper `catchWrap` ([350fc9b](https://github.com/KnodesCommunity/typedoc-plugins/commit/350fc9b9281fce5b7bd7c98253af4a4ef8f66d79))
106+
107+
108+
## 0.22.0 (2022-02-23)
109+
110+
111+
No notable changes were done in this version.
112+
113+
114+
## 0.0.1 (2022-02-23)

packages/theme-demo/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!-- HEADER -->
2+
# @knodes/typedoc-theme-demo
3+
4+
[![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)
5+
[![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)
6+
[![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)
7+
8+
---
9+
10+
[![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)
11+
[![Code Climate coverage](https://img.shields.io/codeclimate/coverage-letter/KnodesCommunity/typedoc-plugins?style=for-the-badge)](https://codeclimate.com/github/KnodesCommunity/typedoc-plugins)
12+
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/KnodesCommunity/typedoc-plugins?style=for-the-badge)](https://codeclimate.com/github/KnodesCommunity/typedoc-plugins)
13+
14+
For more infos, please refer to [the documentation](https://knodescommunity.github.io/typedoc-plugins/modules/_knodes_typedoc_theme_demo.html)
15+
<!-- HEADER end -->
16+
17+
18+
<!-- INSTALL -->
19+
## Quick start
20+
21+
```sh
22+
npm install --save-dev @knodes/typedoc-theme-demo typedoc@^0.23.0
23+
```
24+
25+
## Compatibility
26+
27+
This plugin version should match TypeDoc `^0.23.0` for compatibility.
28+
29+
> **Note**: this plugin version was released by testing against `^0.23.8`.
30+
<!-- INSTALL end -->

packages/theme-demo/__tests__/integration/.keep

Whitespace-only changes.

packages/theme-demo/jest.config.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
const base = require( '../../jest.config.base' )( __dirname );
2+
/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
3+
module.exports = {
4+
...base,
5+
projects: [
6+
base.projects[0],
7+
{
8+
...base.projects[1],
9+
setupFilesAfterEnv: [ ...base.projects[1].setupFilesAfterEnv, '@testing-library/jest-dom' ],
10+
},
11+
],
12+
};

packages/theme-demo/package.json

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"name": "@knodes/typedoc-theme-demo",
3+
"license": "MIT",
4+
"repository": {
5+
"type": "git",
6+
"url": "git+https://github.com/KnodesCommunity/typedoc-plugins.git"
7+
},
8+
"bugs": {
9+
"url": "https://github.com/KnodesCommunity/typedoc-plugins/issues"
10+
},
11+
"homepage": "https://knodescommunity.github.io/typedoc-plugins/modules/_knodes_typedoc_theme_demo.html",
12+
"author": {
13+
"email": "[email protected]",
14+
"name": "GerkinDev"
15+
},
16+
"keywords": [
17+
"documentation",
18+
"typedoc"
19+
],
20+
"main": "dist/index.js",
21+
"files": [
22+
"dist",
23+
"src"
24+
],
25+
"scripts": {
26+
"build": "tsc --project tsconfig.build.json",
27+
"build:clean": "rimraf dist",
28+
"lint": "eslint --ignore-path ../../.eslintignore '**/?(.)*.?([cm])[tj]s?(x)'",
29+
"prepublishOnly": "npm run build:clean && npm run build",
30+
"test": "jest --config jest.config.js"
31+
},
32+
"dependencies": {
33+
"lodash": "^4.17.21",
34+
"@knodes/typedoc-pluginutils": "~0.23.1"
35+
},
36+
"peerDependencies": {
37+
"typedoc": "^0.23.0"
38+
},
39+
"devDependencies": {
40+
"@knodes/eslint-config": "^1.6.5",
41+
"@testing-library/jest-dom": "^5.16.4",
42+
"@types/jest": "^28.1.6",
43+
"@types/jsdom": "^16.2.14",
44+
"@types/lodash": "^4.14.182",
45+
"@types/node": "^18.0.0",
46+
"@types/react": "^18.0.14",
47+
"@typescript-eslint/eslint-plugin": "^5.28.0",
48+
"@typescript-eslint/parser": "^5.28.0",
49+
"eslint": "^8.18.0",
50+
"eslint-plugin-eslint-comments": "^3.2.0",
51+
"eslint-plugin-import": "^2.26.0",
52+
"eslint-plugin-jsdoc": "^39.3.3",
53+
"eslint-plugin-prefer-arrow": "^1.2.3",
54+
"eslint-plugin-sort-export-all": "^1.2.2",
55+
"jest": "^28.1.1",
56+
"jest-extended": "^3.0.1",
57+
"jest-junit": "^14.0.0",
58+
"jsdom": "^19.0.0",
59+
"rimraf": "^3.0.2",
60+
"ts-jest": "^28.0.5",
61+
"typedoc": "^0.23.8",
62+
"typescript": "^4.7.4"
63+
}
64+
}

packages/theme-demo/src/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export const STUB = '';
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
{
2+
"extends": "../../tsconfig.base.json",
3+
"compilerOptions": {
4+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
5+
6+
/* Basic Options */
7+
"incremental": true, /* Enable incremental compilation */
8+
// "target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
9+
// "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
10+
// "lib": [], /* Specify library files to be included in the compilation. */
11+
// "allowJs": true, /* Allow javascript files to be compiled. */
12+
// "checkJs": true, /* Report errors in .js files. */
13+
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
14+
// "declaration": true, /* Generates corresponding '.d.ts' file. */
15+
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
16+
// "sourceMap": true, /* Generates corresponding '.map' file. */
17+
// "outFile": "./", /* Concatenate and emit output to single file. */
18+
"outDir": "./dist", /* Redirect output structure to the directory. */
19+
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
20+
// "composite": true, /* Enable project compilation */
21+
"tsBuildInfoFile": "./dist/tsconfig.tsbuildinfo", /* Specify file to store incremental compilation information */
22+
// "removeComments": true, /* Do not emit comments to output. */
23+
// "noEmit": true, /* Do not emit outputs. */
24+
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
25+
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
26+
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
27+
28+
/* Strict Type-Checking Options */
29+
// "strict": true, /* Enable all strict type-checking options. */
30+
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
31+
// "strictNullChecks": true, /* Enable strict null checks. */
32+
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
33+
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
34+
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
35+
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
36+
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
37+
38+
/* Additional Checks */
39+
// "noUnusedLocals": true, /* Report errors on unused locals. */
40+
// "noUnusedParameters": true, /* Report errors on unused parameters. */
41+
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
42+
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
43+
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
44+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
45+
// "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */
46+
47+
/* Module Resolution Options */
48+
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
49+
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
50+
"paths": {
51+
"#plugintestbed": ["packages/plugintestbed"],
52+
"@knodes/typedoc-*": ["packages/*"],
53+
}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
54+
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
55+
// "typeRoots": [], /* List of folders to include type definitions from. */
56+
// "types": [], /* Type declaration files to be included in compilation. */
57+
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
58+
// "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
59+
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
60+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
61+
62+
/* Source Map Options */
63+
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
64+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
65+
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
66+
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
67+
68+
/* Experimental Options */
69+
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
70+
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
71+
72+
/* Advanced Options */
73+
// "skipLibCheck": true, /* Skip type checking of declaration files. */
74+
// "forceConsistentCasingInFileNames": true, /* Disaw inconsistently-cased references to the same file. */
75+
},
76+
"include": ["src", "types/src.d.ts"],
77+
"exclude": ["**/*.spec.ts"]
78+
}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"extends": "./tsconfig.build.json",
3+
"compilerOptions": {
4+
"types": [
5+
"jest",
6+
"jest-extended",
7+
"@testing-library/jest-dom",
8+
"node"
9+
],
10+
"paths": {
11+
"#plugintestbed": ["packages/plugintestbed/src"],
12+
"@knodes/typedoc-*": ["packages/*/src"],
13+
}
14+
},
15+
"include": ["src", "__tests__", "types/test.d.ts"],
16+
"exclude": []
17+
}

0 commit comments

Comments
 (0)