Merge pull request #14 from forman/0.1.0-alpha.6

0.1.0 alpha.6

Author: forman

.github/PULL_REQUEST_TEMPLATE/code_change.md

@@ -0,0 +1,26 @@
+## Description
+
+_Describe the change and include links to relevant issue(s) here._
+
+## Checklist
+
+_Check all and include list in PR:_
+
+- [ ] I have checked to ensure there aren't other open
+  [Pull Requests](https://github.com/forman/extendit/pulls)
+  for the same update/change
+- [ ] I respect this project's
+  [Code of Conduct](https://github.com/forman/extendit/blob/main/CODE_OF_CONDUCT.md)
+- [ ] I formatted code according to this project's `prettier` configuration.
+- [ ] I verified `npm run lint` runs without errors.
+- [ ] I verified `npm run test` runs without errors.
+- [ ] I verified `npm run coverage` is at 100% for any change.
+
+_Check and keep if applicable_
+
+- [ ] I verified `npm run typedoc` runs without errors.
+- [ ] I have updated or added new documentation relevant for the change.
+
+_More details regarding our coding convention can be found in the
+[contributing](https://github.com/forman/extendit/blob/main/CONTRIBUTING.md) 
+guideline._

.github/PULL_REQUEST_TEMPLATE/doc_change.md

@@ -0,0 +1,17 @@
+## Description
+
+_Describe the change and include links to relevant issue(s) here._
+
+## Checklist
+
+_Check all and include list in PR:_
+
+- [ ] I have checked to ensure there aren't other open
+  [Pull Requests](https://github.com/forman/extendit/pulls)
+  for the same update/change
+- [ ] I respect this project's
+  [Code of Conduct](https://github.com/forman/extendit/blob/main/CODE_OF_CONDUCT.md)
+
+_Check and keep if applicable_
+
+- [ ] I verified `npm run typedoc` runs without errors.

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# How to contribute
+
+The [ExtendIt.js](README.md) project welcomes contributions of any form
+as long as you respect our [code of conduct](CODE_OF_CONDUCT.md) and stay in line with 
+the following instructions and guidelines.
+
+If you have suggestions, ideas, feature requests, or if you have identified
+a malfunction or error, then please 
+[post an issue](https://github.com/forman/extendit/issues). 
+
+If you'd like to submit code or documentation changes, we ask you to provide a 
+[PR](https://github.com/forman/extendit/pulls). 
+For code and configuration changes, your PR must be linked to a 
+corresponding issue. 
+
+To ensure that your code contributions are consistent with our project’s
+coding guidelines, please make sure all applicable items of the following 
+checklist are addressed in your PR.  
+
+**PR checklist**
+
+* Use language [TypeScript](https://www.typescriptlang.org/) using the same
+  [configuration](tsconfig.json) as we do.
+* Format code using [prettier](https://prettier.io/) using the same 
+  [configuration](.prettierrc.json) as we do.
+* Inspect code using [eslint](https://eslint.org/) using the same 
+  [configuration](.eslintrc.cjs) as we do.
+  `npm run lint` must run without errors.
+* Your change shall not break existing unit tests.
+  `npm run test` must run without errors.
+* Add unit tests for any new code not yet covered by tests
+  using [vitest](https://vitest.dev/). 
+  If you add new modules make sure you add a test module 
+  `<name>.test.ts` for each next to it.
+* Make sure test coverage is at 100% for any change.
+  Use `npm run coverage` to verify.
+* If you add or change new public API components, add or change API 
+  documentation accordingly using 
+  [TSDoc](https://tsdoc.org/). 
+  `npm run typedoc` must run without errors.
+* If your change affects the current project documentation,
+  (currently only the [README](README.md) file)
+  please adjust it and include the change in the PR.

TODO.md

@@ -2,12 +2,20 @@
 
 ## For first stable version
 
-* Make `contrib` an own toplevel subpackage 
+* Add TSDoc to all types, classes, members, methods,
+  functions, and constants also in `util` and `contrib`.
+* Review and adjust logging, check for consistent use of logger names 
+  and log levels.
+* Add coverage badge in `README.md`.
+
+## Potential design changes for later versions
+
+* Make `contrib` an own toplevel subpackage
   - Every contribution point should go into a separate submodule.
   - Every submodule should be exported, so points can
     be imported independently of each other and so tree-shaking
     becomes possible during build.
-  - Every submodule should have its own `index` and comprise implementation 
+  - Every submodule should have its own `index` and comprise implementation
     modules `types`, `point`, `get`, `hooks`, and optionally others.
   - Add unit tests for each module of a submodule.
   - Allow using the contrib module without React.
@@ -16,16 +24,6 @@
   Some exports of current `framework/util` are used by public `core` and
   `contrib` APIs. These elements may then be re-exported by `core` and
   `contrib` to hide an extra `utils` package.
-* Implement a GH action that builds documentation in `./docs` including 
-  API docs, so we don't have to include generated API docs pages in source code.
-* Add TSDoc to all types, classes, members, methods,
-  functions, and constants also in `util` and `contrib`.
-* Review and adjust logging, check for consistent use of logger names 
-  and log levels.
-* Add coverage badge in `README.md`.
-
-## Potential design changes for later versions
-
 * Split exported modules into separate packages:
   - Use [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces).
   - Turn single-package repo into monorepo comprising multiple 

docs/.gitignore

@@ -1,6 +1,6 @@
 {
   "name": "@forman2/extendit",
-  "version": "0.1.0-alpha.5",
+  "version": "0.1.0-alpha.6",
   "type": "module",
   "displayName": "ExtendIt.js",
   "description": "A framework supporting development of extensible and scalable JavaScript applications",
@@ -13,17 +13,13 @@
   "keywords": [
     "dependency inversion",
     "dependency injection",
-    "contributions",
-    "extensions",
-    "management",
-    "manager",
+    "extension management",
     "state",
     "store",
     "react"
   ],
   "files": [
     "dist",
-    "src",
     "logo.png"
   ],
   "exports": {

package-lock.json

@@ -76,6 +76,7 @@ function processCommand(command: CommandManifestEntry): Command {
  * {@link commandsPoint}.
  *
  * @category UI Contributions API
+ * @experimental
  */
 export const commandsPoint: ContributionPoint<
   CommandManifestEntry[],

package.json

@@ -70,6 +70,7 @@ const configurationSchema = {
  * {@link configurationPoint}.
  *
  * @category UI Contributions API
+ * @experimental
  */
 export const configurationPoint: ContributionPoint<Configuration> = {
   id: "configuration",

src/framework/contrib/commands.ts

@@ -60,11 +60,12 @@ const schema: JSONSchemaType<DataViewManifestEntry[]> = {
 };
 
 /**
- * The "views" contribution point.
+ * The "dataViews" contribution point.
  * To register in your app, call {@link registerContributionPoint} with
  * {@link dataViewsPoint}.
  *
  * @category UI Contributions API
+ * @experimental
  */
 export const dataViewsPoint: ContributionPoint<DataViewManifestEntry[]> = {
   id: "dataViews",