Merge pull request #840 from Sitecore/feature/467457-api-reference-generation

[Focused Improvements] Generate API reference docs

Author: addy-pathania

package.json

@@ -35,6 +35,5 @@
     "typedoc": "^0.22.5",
     "typedoc-plugin-markdown": "^3.11.3",
     "typescript": "^3.9.6"
-  },
-  "dependencies": {}
-}
+  }
+}

packages/sitecore-jss-angular-schematics/package.json

@@ -6,7 +6,8 @@
     "build": "tsc -p tsconfig.json",
     "test-package": "jasmine src/**/*_spec.js",
     "test": "npm run build && npm run test-package",
-    "coverage": "nyc npm run test-package"
+    "coverage": "nyc npm run test-package",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-angular-schematics src/jss-component/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

packages/sitecore-jss-angular/package.json

@@ -7,7 +7,8 @@
     "lint": "eslint ./src/**/*.ts",
     "test": "karma start",
     "test:watch": "karma start --no-single-run --browsers Chrome",
-    "coverage": "npm test"
+    "coverage": "npm test",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-angular src/public_api.ts --githubPages false"
   },
   "author": {
     "name": "Sitecore Corporation",

packages/sitecore-jss-dev-tools/package.json

@@ -12,7 +12,8 @@
     "lint": "eslint ./src/**/*.ts",
     "test": "mocha --require ts-node/register -r tsconfig-paths/register  \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
-    "coverage": "nyc npm test"
+    "coverage": "nyc npm test",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-dev-tools src/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

packages/sitecore-jss-dev-tools/src/manifest-manager.ts

@@ -92,15 +92,15 @@ export class ManifestManager {
       ignorePermissionErrors: true,
       cwd: this.rootPath,
     })
-      .on('all', async (event, path) => {
+      .on('all', async (event: string, path: string) => {
         console.log(`Manifest source file ${path} changed (${event}), reloading manifest...`);
         try {
           callback(await generateToVariable(this.manifestArgs));
         } catch (e) {
           console.error(e);
         }
       })
-      .on('error', (error) => console.error(`Manifest watcher error: ${error}`));
+      .on('error', (error: string) => console.error(`Manifest watcher error: ${error}`));
 
     console.log('Manifest manager is watching for manifest source file changes...');
   }

packages/sitecore-jss-forms/package.json

@@ -10,7 +10,8 @@
     "lint": "eslint ./src/**/*.ts",
     "test": "mocha --require ts-node/register \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
-    "coverage": "nyc npm test"
+    "coverage": "nyc npm test",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-forms src/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

packages/sitecore-jss-nextjs/package.json

@@ -11,7 +11,7 @@
     "test": "mocha --require ts-node/register/transpile-only --require ./src/tests/shim.ts ./src/tests/jsdom-setup.ts ./src/tests/enzyme-setup.ts \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../ref-docs/sitecore-jss-nextjs src/index.ts"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs src/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

packages/sitecore-jss-proxy/package.json

@@ -11,7 +11,8 @@
     "lint": "eslint ./src/**/*.ts",
     "test": "mocha --require ts-node/register \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
-    "coverage": "nyc npm test"
+    "coverage": "nyc npm test",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-proxy src/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

packages/sitecore-jss-react-forms/package.json

@@ -10,7 +10,8 @@
     "lint": "eslint ./src/**/*.tsx ./src/**/*.ts",
     "test": "mocha --require ts-node/register/transpile-only --require ./src/tests/shim.ts ./src/tests/jsdom-setup.ts ./src/tests/enzyme-setup.ts \"./src/**/*.test.tsx\"",
     "prepublishOnly": "npm run build",
-    "coverage": "nyc npm test"
+    "coverage": "nyc npm test",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-forms src/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

packages/sitecore-jss-react-native/package.json

@@ -11,7 +11,8 @@
     "lint": "eslint ./src/**/*.tsx ./src/**/*.ts",
     "test": "jest",
     "prepublishOnly": "npm test && npm run build",
-    "coverage": "jest --config ./jest.config.coverage.js"
+    "coverage": "jest --config ./jest.config.coverage.js",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-react-native src/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

packages/sitecore-jss-react/package.json

@@ -11,7 +11,7 @@
     "test": "mocha --require ts-node/register/transpile-only --require ./src/tests/shim.ts ./src/tests/jsdom-setup.ts ./src/tests/enzyme-setup.ts \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../ref-docs/sitecore-jss-react src/index.ts"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-react src/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

packages/sitecore-jss-rendering-host/package.json

@@ -10,7 +10,8 @@
     "lint": "eslint ./src/**/*.ts",
     "test": "mocha --require ts-node/register/transpile-only \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
-    "coverage": "nyc npm test"
+    "coverage": "nyc npm test",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-rendering-host src/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.10"

packages/sitecore-jss-vue/package.json

@@ -11,7 +11,8 @@
     "lint": "eslint ./src/**/*.ts",
     "test": "jest",
     "prepublishOnly": "npm run build",
-    "coverage": "jest --config ./jest.config.coverage.js"
+    "coverage": "jest --config ./jest.config.coverage.js",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-vue src/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

packages/sitecore-jss/package.json

@@ -11,7 +11,7 @@
     "test": "mocha --require ts-node/register \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../ref-docs/sitecore-jss src/index.ts"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss --entryPoints src/index.ts --entryPoints src/utils/index.ts  --entryPoints src/media/index.ts  --entryPoints src/tracking/index.ts  --entryPoints src/layout/index.ts --entryPoints src/graphql/index.ts --githubPages false"
   },
   "engines": {
     "node": ">=8.1"

ref-docs/sitecore-jss-angular-schematics/README.md

@@ -0,0 +1,41 @@
+@sitecore-jss/sitecore-jss-angular-schematics
+
+# @sitecore-jss/sitecore-jss-angular-schematics
+
+## Table of contents
+
+### Functions
+
+- [default](README.md#default)
+
+## Functions
+
+### default
+
+▸ **default**(`options`): (`host`: `Tree`) => `Promise`<`Rule`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | `Schema` |
+
+#### Returns
+
+`fn`
+
+▸ (`host`): `Promise`<`Rule`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `host` | `Tree` |
+
+##### Returns
+
+`Promise`<`Rule`\>
+
+#### Defined in
+
+[index.ts:41](https://github.com/Sitecore/jss/blob/08de6c61/packages/sitecore-jss-angular-schematics/src/jss-component/index.ts#L41)