diff --git a/package.json b/package.json index c2d9b10536..33c58dbb25 100644 --- a/package.json +++ b/package.json @@ -32,6 +32,7 @@ "@angular/router": "6.0.2", "@commitlint/cli": "6.2.0", "@commitlint/config-conventional": "6.1.3", + "@compodoc/compodoc": "1.1.3", "@ngtools/json-schema": "1.1.0", "codelyzer": "4.3.0", "conventional-changelog-cli": "1.3.22", @@ -65,7 +66,7 @@ "build:stark-testing": "npm run build -- --packages=stark-testing", "build:stark-ui": "npm run build -- --packages=stark-ui", "clean": "npx rimraf ./dist", - "clean:all": "npm run clean && npm run clean:stark-build && npm run clean:stark-core && npm run clean:stark-testing && npm run clean:starter", + "clean:all": "npm run clean && npm run clean:stark-build && npm run clean:stark-core && npm run clean:stark-ui && npm run clean:stark-testing && npm run clean:starter", "clean:stark-build": "cd packages/stark-build && npm run clean && cd ../..", "clean:stark-core": "cd packages/stark-core && npm run clean && cd ../..", "clean:stark-testing": "cd packages/stark-testing && npm run clean && cd ../..", @@ -80,6 +81,12 @@ "clean:modules:starter": "cd starter && npm run clean:modules && cd ..", "commit": "./node_modules/.bin/git-cz", "commitmsg": "commitlint -e $GIT_PARAMS", + "docs": "npm run docs:clean && npm run docs:all", + "docs:all": "npm run docs:stark-core && npm run docs:stark-ui", + "docs:clean": "npx rimraf reports/api-docs", + "docs:stark-core": "cd packages/stark-core && npm run docs && cd ../..", + "docs:stark-ui": "cd packages/stark-ui && npm run docs && cd ../..", + "docs:starter": "cd starter && npm run docs && cd ..", "generate:changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0", "generate:changelog-recent": "conventional-changelog -p angular | tail -n +3", "lint": "tslint --config tslint.json --project ./packages/tsconfig.json --format codeFrame", diff --git a/packages/stark-build/README.md b/packages/stark-build/README.md new file mode 100644 index 0000000000..62118b4e57 --- /dev/null +++ b/packages/stark-build/README.md @@ -0,0 +1,11 @@ +[![NPM version](https://img.shields.io/npm/v/@nationalbankbelgium/stark-build.svg)](https://www.npmjs.com/package/@nationalbankbelgium/stark-build) +[![npm](https://img.shields.io/npm/dm/@nationalbankbelgium/stark-build.svg)](https://www.npmjs.com/package/@nationalbankbelgium/stark-build) +[![Build Status](https://travis-ci.org/NationalBankBelgium/stark.svg?branch=master)](https://travis-ci.org/NationalBankBelgium/stark) +[![Dependency Status](https://david-dm.org/NationalBankBelgium/stark-build.svg)](https://david-dm.org/NationalBankBelgium/stark-build) +[![devDependency Status](https://david-dm.org/NationalBankBelgium/stark-build/dev-status.svg)](https://david-dm.org/NationalBankBelgium/stark-build#info=devDependencies) +[![License](https://img.shields.io/cocoapods/l/AFNetworking.svg)](LICENSE) + +# Stark Build + +Stark's build module (aka stark-build) provides the build configurations of the Stark framework. +It includes our default configuration for webpack, json-server, prettier, stylelint, ... diff --git a/packages/stark-core/README.md b/packages/stark-core/README.md new file mode 100644 index 0000000000..dd697d52bb --- /dev/null +++ b/packages/stark-core/README.md @@ -0,0 +1,10 @@ +[![NPM version](https://img.shields.io/npm/v/@nationalbankbelgium/stark-core.svg)](https://www.npmjs.com/package/@nationalbankbelgium/stark-core) +[![npm](https://img.shields.io/npm/dm/@nationalbankbelgium/stark-core.svg)](https://www.npmjs.com/package/@nationalbankbelgium/stark-core) +[![Build Status](https://travis-ci.org/NationalBankBelgium/stark.svg?branch=master)](https://travis-ci.org/NationalBankBelgium/stark) +[![Dependency Status](https://david-dm.org/NationalBankBelgium/stark-core.svg)](https://david-dm.org/NationalBankBelgium/stark-core) +[![devDependency Status](https://david-dm.org/NationalBankBelgium/stark-core/dev-status.svg)](https://david-dm.org/NationalBankBelgium/stark-core#info=devDependencies) +[![License](https://img.shields.io/cocoapods/l/AFNetworking.svg)](LICENSE) + +# Stark Core + +Stark's core module (aka stark-core) provides the foundations of the Stark framework. diff --git a/packages/stark-core/package.json b/packages/stark-core/package.json index f3dea9fee6..f1ec0e822a 100644 --- a/packages/stark-core/package.json +++ b/packages/stark-core/package.json @@ -59,6 +59,7 @@ "clean": "npx rimraf dist", "clean:modules": "npx rimraf ./node_modules package-lock.json", "clean:all": "npm run clean && npm run clean:modules", + "docs": "node ../../node_modules/@compodoc/compodoc/bin/index-cli src --theme material --tsconfig ../tsconfig.json --output ../../reports/api-docs/stark-core", "ngc": "node ./../node_modules/@angular/compiler-cli/src/main.js -p tsconfig-build.json", "lint": "node ../../node_modules/tslint/bin/tslint --config tslint.json --project ./tsconfig.spec.json --format codeFrame", "test-fast": "node ./node_modules/@nationalbankbelgium/stark-testing/node_modules/karma/bin/karma start ./karma.conf.typescript.js", diff --git a/packages/stark-testing/README.md b/packages/stark-testing/README.md new file mode 100644 index 0000000000..4b46fc24af --- /dev/null +++ b/packages/stark-testing/README.md @@ -0,0 +1,11 @@ +[![NPM version](https://img.shields.io/npm/v/@nationalbankbelgium/stark-testing.svg)](https://www.npmjs.com/package/@nationalbankbelgium/stark-testing) +[![npm](https://img.shields.io/npm/dm/@nationalbankbelgium/stark-testing.svg)](https://www.npmjs.com/package/@nationalbankbelgium/stark-testing) +[![Build Status](https://travis-ci.org/NationalBankBelgium/stark.svg?branch=master)](https://travis-ci.org/NationalBankBelgium/stark) +[![Dependency Status](https://david-dm.org/NationalBankBelgium/stark-testing.svg)](https://david-dm.org/NationalBankBelgium/stark-testing) +[![devDependency Status](https://david-dm.org/NationalBankBelgium/stark-testing/dev-status.svg)](https://david-dm.org/NationalBankBelgium/stark-testing#info=devDependencies) +[![License](https://img.shields.io/cocoapods/l/AFNetworking.svg)](LICENSE) + +# Stark Testing + +Stark's testing module (aka stark-testing) provides the testing facilities of the Stark framework. +It includes the default testing dependencies that we recommend (Jasmine/Karma) and provides configuration files for those, as well as support for code coverage reports. diff --git a/packages/stark-ui/README.md b/packages/stark-ui/README.md new file mode 100644 index 0000000000..d2493fc45c --- /dev/null +++ b/packages/stark-ui/README.md @@ -0,0 +1,11 @@ +[![NPM version](https://img.shields.io/npm/v/@nationalbankbelgium/stark-ui.svg)](https://www.npmjs.com/package/@nationalbankbelgium/stark-ui) +[![npm](https://img.shields.io/npm/dm/@nationalbankbelgium/stark-ui.svg)](https://www.npmjs.com/package/@nationalbankbelgium/stark-ui) +[![Build Status](https://travis-ci.org/NationalBankBelgium/stark.svg?branch=master)](https://travis-ci.org/NationalBankBelgium/stark) +[![Dependency Status](https://david-dm.org/NationalBankBelgium/stark-ui.svg)](https://david-dm.org/NationalBankBelgium/stark-ui) +[![devDependency Status](https://david-dm.org/NationalBankBelgium/stark-ui/dev-status.svg)](https://david-dm.org/NationalBankBelgium/stark-ui#info=devDependencies) +[![License](https://img.shields.io/cocoapods/l/AFNetworking.svg)](LICENSE) + +# Stark UI + +Stark's UI module (aka stark-ui) provides the UI related features of the Stark framework. +It includes the UI component kit of Stark as well as other services and utilities. diff --git a/packages/stark-ui/package.json b/packages/stark-ui/package.json index f38e09aba6..1e9e44c440 100644 --- a/packages/stark-ui/package.json +++ b/packages/stark-ui/package.json @@ -45,6 +45,7 @@ "clean": "npx rimraf dist", "clean:modules": "npx rimraf ./node_modules package-lock.json", "clean:all": "npm run clean && npm run clean:modules", + "docs": "node ../../node_modules/@compodoc/compodoc/bin/index-cli src --theme material --tsconfig ../tsconfig.json --output ../../reports/api-docs/stark-ui", "ngc": "node ./../node_modules/@angular/compiler-cli/src/main.js -p tsconfig-build.json", "lint": "node ../../node_modules/tslint/bin/tslint --config tslint.json --project ./tsconfig.spec.json --format codeFrame", "test-fast": "node ./node_modules/@nationalbankbelgium/stark-testing/node_modules/karma/bin/karma start ./karma.conf.typescript.js", diff --git a/starter/package.json b/starter/package.json index b4b145325b..03aecbafaf 100644 --- a/starter/package.json +++ b/starter/package.json @@ -47,8 +47,10 @@ "clean:modules": "npm run rimraf -- node_modules package-lock.json", "clean:install": "npm set progress=false && npm install", "clean": "npm cache clean --force && npm run rimraf -- node_modules doc coverage reports dist compiled dll", + "compodoc": "compodoc", "docker": "docker", - "docs": "npm run typedoc -- --options typedoc.json --exclude '**/*.spec.ts' ./src/", + "docs": "npm run docs:clean && compodoc src --theme material --tsconfig ./tsconfig.json --output ./reports/api-docs", + "docs:clean": "npx rimraf reports/api-docs", "e2e:live": "npm-run-all -p -r server:prod:ci protractor:live", "e2e:travis": "npm-run-all -p -r server:prod:ci protractor:delay", "e2e": "npm-run-all -p -r server:prod:ci protractor", @@ -85,7 +87,6 @@ "test-fast:ci": "karma start karma.conf.typescript.ci.js", "tsc": "tsc", "tslint": "tslint", - "typedoc": "typedoc", "version": "npm run build", "watch:dev:hmr": "npm run watch:dev -- --hot", "watch:dev": "npm run build:dev -- --watch", @@ -119,8 +120,8 @@ "@angular/platform-server": "6.0.2", "@angular/router": "6.0.2", "@mdi/angular-material": "2.3.54", - "@nationalbankbelgium/stark-core": "file:../dist/packages-dist/stark-core/nationalbankbelgium-stark-core-10.0.0-alpha.2-e0e5d54.tgz", - "@nationalbankbelgium/stark-ui": "file:../dist/packages-dist/stark-ui/nationalbankbelgium-stark-ui-10.0.0-alpha.2-e0e5d54.tgz", + "@nationalbankbelgium/stark-core": "file:../dist/packages-dist/stark-core/nationalbankbelgium-stark-core-10.0.0-alpha.2-c7f4955.tgz", + "@nationalbankbelgium/stark-ui": "file:../dist/packages-dist/stark-ui/nationalbankbelgium-stark-ui-10.0.0-alpha.2-c7f4955.tgz", "@uirouter/visualizer": "6.0.0", "core-js": "2.5.6", "eligrey-classlist-js-polyfill": "1.2.20180112", @@ -135,11 +136,12 @@ "zone.js": "0.8.26" }, "devDependencies": { - "@nationalbankbelgium/stark-build": "file:../dist/packages-dist/stark-build/nationalbankbelgium-stark-build-10.0.0-alpha.2-e0e5d54.tgz", - "@nationalbankbelgium/stark-testing": "file:../dist/packages-dist/stark-testing/nationalbankbelgium-stark-testing-10.0.0-alpha.2-e0e5d54.tgz", + "@nationalbankbelgium/stark-build": "file:../dist/packages-dist/stark-build/nationalbankbelgium-stark-build-10.0.0-alpha.2-c7f4955.tgz", + "@nationalbankbelgium/stark-testing": "file:../dist/packages-dist/stark-testing/nationalbankbelgium-stark-testing-10.0.0-alpha.2-c7f4955.tgz", "@types/core-js": "0.9.46", "@types/hammerjs": "2.0.35", "@types/node": "8.10.15", + "@compodoc/compodoc": "1.1.3", "cross-env": "^5.1.5", "find-root": "^1.1.0", "gh-pages": "1.1.0", diff --git a/starter/typedoc.json b/starter/typedoc.json deleted file mode 100644 index 5546b06727..0000000000 --- a/starter/typedoc.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "mode": "modules", - "out": "doc", - "theme": "default", - "ignoreCompilerErrors": "true", - "experimentalDecorators": "true", - "emitDecoratorMetadata": "true", - "target": "ES5", - "moduleResolution": "node", - "preserveConstEnums": "true", - "stripInternal": "true", - "suppressExcessPropertyErrors": "true", - "suppressImplicitAnyIndexErrors": "true", - "module": "commonjs" -}