[project] Add API docs for each project (#136)

* fix: allow typings to be used for each project

* fix: add missing tsdoc npmignore entries

* fix: use relative path imports

* fix: add changelogs

* docs: add basic project documentation

* fix: remove boilerplate docs

* feat: add heft rig for API extraction and documentation

* fix: add missing heft dependency

* fix: typescript plugin issues

* fix: update dependencies

* fix: remove vite plugin for d.ts files

* fix: re-enable heft typescript plugin

* fix: move stories to examples folder

* test: add missing data

* fix: move beam stories to examples folder

* fix: move code editor stories to examples folder

* fix: move node editor stories to examples folder

* fix: move desktop stories to examples folder

* fix: move grapqhl client stories to examples folder

* fix: minor fixes

* style: add lint fixes

* docs: add changelog for themes

* fix: remove unused dependency

* fix: add missing graphql exports

---------

Co-authored-by: Rohan Bansal <[email protected]>

.gitignore

@@ -3,42 +3,49 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
 # Runtime data
 *.pid
 *.seed
 *.pid.lock
 
 # Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
+lib-cov/
 
 # Coverage directory used by tools like istanbul
-coverage
+coverage/
 
 # nyc test coverage
-.nyc_output
+.nyc_output/
 
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
+.grunt/
 
 # Bower dependency directory (https://bower.io/)
-bower_components
+bower_components/
 
 # node-waf configuration
-.lock-wscript
+.lock-wscript/
 
 # Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
+build/Release/
 
 # Dependency directories
 node_modules/
 jspm_packages/
 
+# TypeScript cache
+*.tsbuildinfo
+
 # Optional npm cache directory
-.npm
+.npm/
 
 # Optional eslint cache
-.eslintcache
+.eslintcache/
 
 # Optional REPL history
 .node_repl_history
@@ -51,28 +58,45 @@ jspm_packages/
 
 # dotenv environment variables file
 .env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
 
 # next.js build output
-.next
+.next/
 
-# OS X temporary files
-.DS_Store
+# Docusaurus cache and generated files
+.docusaurus/
 
-# Visual Studio Code
-.vscode
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-!*.code-workspace
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# yarn v2
+.yarn/cache/
+.yarn/unplugged/
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# OS X temporary files
+.DS_Store/
 
 # IntelliJ IDEA project files; if you want to commit IntelliJ settings, this recipe may be helpful:
 # https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 .idea/
 *.iml
 
-# Vitest output files
-.vite/
+# Visual Studio Code
+.vscode/
+!.vscode/tasks.json
+!.vscode/launch.json
 
 # Rush temporary files
 common/deploy/
@@ -81,25 +105,25 @@ common/autoinstallers/*/.npmrc
 **/.rush/temp/
 *.lock
 
+# Common toolchain intermediate files
+temp/
+lib/
+lib-amd/
+lib-es6/
+lib-esnext/
+lib-commonjs/
+lib-shim/
+dist/
+dist-storybook/
+tsdoc-metadata.json
+*.tsbuildinfo
+
 # Heft temporary files
-.cache
-.heft
+.cache/
+.heft/
 
-# Common toolchain intermediate files
-temp
-lib
-lib-amd
-lib-es6
-lib-esnext
-lib-commonjs
-lib-shim
-dist
-dist-storybook
-*.scss.ts
-*.sass.ts
-
-# Typescript build files
-**/tsconfig.tsbuildinfo
+# Vitest output files
+.vite/
 
 # XState generated files
 **/*.typegen.ts

.prettierignore

@@ -7,45 +7,49 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
 # Runtime data
 *.pid
 *.seed
 *.pid.lock
 
 # Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
+lib-cov/
 
 # Coverage directory used by tools like istanbul
-coverage
+coverage/
 
 # nyc test coverage
-.nyc_output
+.nyc_output/
 
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
+.grunt/
 
 # Bower dependency directory (https://bower.io/)
-bower_components
+bower_components/
 
 # node-waf configuration
-.lock-wscript
+.lock-wscript/
 
 # Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Build outputs
-dist/
+build/Release/
 
 # Dependency directories
 node_modules/
 jspm_packages/
 
+# TypeScript cache
+*.tsbuildinfo
+
 # Optional npm cache directory
-.npm
+.npm/
 
 # Optional eslint cache
-.eslintcache
+.eslintcache/
 
 # Optional REPL history
 .node_repl_history
@@ -58,28 +62,85 @@ jspm_packages/
 
 # dotenv environment variables file
 .env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
 
 # next.js build output
-.next
+.next/
+
+# Docusaurus cache and generated files
+.docusaurus/
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# yarn v2
+.yarn/cache/
+.yarn/unplugged/
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
 
 # OS X temporary files
-.DS_Store
+.DS_Store/
+
+# IntelliJ IDEA project files; if you want to commit IntelliJ settings, this recipe may be helpful:
+# https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+.idea/
+*.iml
+
+# Visual Studio Code
+.vscode/
+!.vscode/tasks.json
+!.vscode/launch.json
 
 # Rush temporary files
 common/deploy/
 common/temp/
 common/autoinstallers/*/.npmrc
 **/.rush/temp/
+*.lock
+
+# Common toolchain intermediate files
+temp/
+lib/
+lib-amd/
+lib-es6/
+lib-esnext/
+lib-commonjs/
+lib-shim/
+dist/
+dist-storybook/
+*.tsbuildinfo
+
+# Heft temporary files
+.cache/
+.heft/
+
+# Vitest output files
+.vite/
 
+# XState generated files
+**/*.typegen.ts
 
 #-------------------------------------------------------------------------------------------------------------------
 # Prettier-specific overrides
 #-------------------------------------------------------------------------------------------------------------------
 
-# Rush files
+# Machine-generated files
+common/reviews/
 common/changes/
 common/scripts/
-common/config/
+common/config/rush/browser-approved-packages.json
+common/config/rush/nonbrowser-approved-packages.json
 CHANGELOG.*
 
 # Package manager files
@@ -92,5 +153,5 @@ shrinkwrap.json
 lib
 .github
 
-# Prettier reformats code blocks inside Markdown, which affects rendered output
-*.md
+# We'll consider enabling this later; Prettier reformats code blocks, which affects end-user content
+*.md

aform/.npmignore

@@ -9,6 +9,7 @@
 !/src-*/**
 !/dist/**
 !ThirdPartyNotice.txt
+!tsdoc-metadata.json
 
 # Ignore certain patterns that should not get published.
 /dist/*.stats.*

aform/config/api-extractor.json

@@ -0,0 +1,20 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../common/config/api-extractor-base.json",
+
+	"docModel": {
+		"enabled": true,
+		"projectFolderUrl": "https://github.com/agritheory/stonecrop/tree/development/aform"
+	},
+
+	"messages": {
+		"extractorMessageReporting": {
+			// Disable this validation at your own risk:  Processing an incorrect file type
+			// may lead to other errors.  Function bodies may incorrectly get emitted in the
+			// .d.ts rollup.
+			"ae-wrong-input-file-type": {
+				"logLevel": "none"
+			}
+		}
+	}
+}

aform/config/rig.json

@@ -0,0 +1,6 @@
+// The "rig.json" file directs tools to look for their config files in an external package.
+// Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
+	"rigPackageName": "stonecrop-rig"
+}