Skip to content

Commit

Permalink
Added CLI command for API docs. (#34)
Browse files Browse the repository at this point in the history
* Added entry point for CLI API docs.

* Added API database.

* Added static files for CLI API server.

* Added API generator and TS lib.

* Added API template.

* Added APIServer and fixed API tool.

* Fixed escaping in APIServer.

* Fixed links, navigation, search.

* Fixed GitHub integration.
  • Loading branch information
bre1470 authored Sep 22, 2024
1 parent 3c39ead commit 3942072
Show file tree
Hide file tree
Showing 13 changed files with 7,479 additions and 13 deletions.
2 changes: 2 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,15 @@
"no-nested-ternary": 0,
"no-unmodified-loop-condition": 0,
"no-unused-vars": 1,
"no-useless-escape": 0,
"object-curly-spacing": [2, "always"],
"operator-linebreak": [2, "after"],
"quotes": [2, "single"],
"require-unicode-regexp": 1,
"space-before-function-paren": 2,
"strict": 0,
"eol-last": ["error", "always"],
"@typescript-eslint/require-await": 0,
"@typescript-eslint/restrict-plus-operands": 0,
"@typescript-eslint/restrict-template-expressions": 0,
"jsdoc/check-alignment": 1,
Expand Down
15 changes: 10 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"private": true,
"version": "0.0.1-dev",
"version": "0.0.1-repository",
"name": "@highcharts/connectors-morningstar",
"license": "UNLICENSED",
"description": "Highcharts connectors for Morningstar Direct Web Services",
Expand Down Expand Up @@ -42,11 +42,16 @@
"highcharts": ">=11.4.0"
},
"scripts": {
"api": "npm run webpack && npm run api:server",
"api:server": "(sleep 1 ; open http://localhost:8005) & node bin/connectors-morningstar api",
"build": "npm run webpack && npm run build:prepare && npm run build:copy && npm run build:pack && npm run build:cleanup",
"build:cleanup": "rm -rf build/package/",
"build:copy": "cp -R bin code/* demos LICENSE.md README.md build/package/ && cp -R docs/connectors/ build/package/docs/ && cp package-build.json build/package/package.json",
"build:copy": "npm run copy:code && npm run copy:docs && npm run copy:json",
"build:pack": "npm pack build/package/ --pack-destination build/",
"build:prepare": "rm -rf build/ ; mkdir -p build/package/",
"copy:code": "cp -R bin code/* demos LICENSE.md README.md build/package/",
"copy:docs": "cp -R docs/connectors/ build/package/docs/",
"copy:json": "cp package-build.json build/package/package.json",
"demos": "npm run webpack && npm run demos:server",
"demos:server": "(sleep 1 ; open http://localhost:8080) & node bin/connectors-morningstar demos",
"docs": "npm run webpack && npm run docs:server",
Expand All @@ -55,16 +60,16 @@
"husky:pre-commit": "npx lint-staged && npm run webpack",
"prepare": "rm -rf '.husky/_' ; husky",
"scripts": "npm run scripts:bin && npm run scripts:code",
"scripts:bin": "rm -rf bin/ ; tsc -p src/CLI/ ; chmod +x bin/*.js",
"scripts:code": "rm -rf code/ ; tsc -p src/",
"scripts:bin": "rm -rf bin/ && tsc -p src/CLI/ && chmod +x bin/*.js && cp -R src/CLI/Static bin/ && ts-node tools/api",
"scripts:code": "rm -rf code/ && tsc -p src/",
"reset": "rm -rf bin/ build/ code/ node_modules/ ; npm i",
"test": "npm run webpack && npm run test:eslint && npm run test:tests",
"test:eslint": "eslint .",
"test:morningstar": "npx -y newman run --bail tmp/Collection.json -e tmp/Environment.json",
"test:tests": "ts-node tools/tests",
"watch": "tsc -p src/ -w",
"webpack": "npm run scripts && webpack && npm run webpack:dts",
"webpack:dts": "npm run webpack:dts:cm && npm run webpack:dts:dbm && npm run webpack:dts:dgm && npm run webpack:dts:hcm",
"webpack:dts": "npm run webpack:dts:cm",
"webpack:dts:cm": "cp src/webpack.d.ts code/connectors-morningstar.d.ts && cp src/webpack.d.ts code/connectors-morningstar.src.d.ts",
"webpack:dts:dbm": "cp src/webpack.d.ts code/dashboards-morningstar.d.ts && cp src/webpack.d.ts code/dashboards-morningstar.src.d.ts",
"webpack:dts:dgm": "cp src/webpack.d.ts code/datagrid-morningstar.d.ts && cp src/webpack.d.ts code/datagrid-morningstar.src.d.ts",
Expand Down
1 change: 1 addition & 0 deletions src/.eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
"valid-jsdoc": 0,
"eol-last": ["error", "always"],
"@typescript-eslint/array-type": 0,
"@typescript-eslint/require-await": 0,
"@typescript-eslint/explicit-function-return-type": 0, // covered by TypeScript
"@typescript-eslint/indent": [
"error",
Expand Down
Loading

0 comments on commit 3942072

Please sign in to comment.