diff --git a/.gitignore b/.gitignore index c3fbc3e..8545a1d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ dist node_modules coverage -.env \ No newline at end of file +.env diff --git a/README.md b/README.md index d70e33c..454fb70 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,17 @@ this phantom aim to search in the [marmiton](https://www.marmiton.org) website +## starting the project +checkout this repo and go to root directory + +launch `npm i` + +launch `npm run test` to ensure all test pass + +to auto-transpile launch `npm run watch` + +to auto-deploy on build launch `npm run auto-deploy` + +to test with online instance launch `npm run online` + want some [docs](./docs/modules.md) ? diff --git a/package-lock.json b/package-lock.json index f2c42ed..942b361 100644 --- a/package-lock.json +++ b/package-lock.json @@ -814,6 +814,12 @@ "chalk": "^4.0.0" } }, + "@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==", + "dev": true + }, "@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -1372,6 +1378,12 @@ "integrity": "sha512-9IK9EadsbHo6jLWIpxpR6pL0sazTXV6+SQv25ZB+F7Bj9mJNaOc4nCRabwd5M/JwmUa8idz6Eci6eKfJryPs6Q==", "dev": true }, + "abbrev": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", + "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", + "dev": true + }, "acorn": { "version": "8.7.0", "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz", @@ -1559,6 +1571,12 @@ "es-abstract": "^1.19.0" } }, + "async": { + "version": "0.1.22", + "resolved": "https://registry.npmjs.org/async/-/async-0.1.22.tgz", + "integrity": "sha1-D8GqoIig4+8Ovi2IMbqw3PiEUGE=", + "dev": true + }, "asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", @@ -1800,6 +1818,15 @@ "integrity": "sha512-cOU9usZw8/dXIXKtwa8pM0OTJQuJkxMN6w30csNRUerHfeQ5R6U3kkU/FtJeIf3M202OHfY2U8ccInBG7/xogA==", "dev": true }, + "cli": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/cli/-/cli-0.4.3.tgz", + "integrity": "sha1-5oGcjV+qlX9k+Y9mqFBiaMHR8X0=", + "dev": true, + "requires": { + "glob": ">= 3.1.4" + } + }, "cliui": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/cliui/-/cliui-2.1.0.tgz", @@ -1916,6 +1943,11 @@ "which": "^2.0.1" } }, + "crypto-browserify": { + "version": "git+https://github.com/dominictarr/crypto-browserify.git#95c5d50581ce0b4fff6e76e45dc0bb3622be4e9a", + "from": "git+https://github.com/dominictarr/crypto-browserify.git#95c5d505", + "dev": true + }, "cson": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/cson/-/cson-3.0.2.tgz", @@ -3954,6 +3986,33 @@ "integrity": "sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==", "dev": true }, + "jshint": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/jshint/-/jshint-0.9.1.tgz", + "integrity": "sha1-/zLsfwn4QAH3SY7q/WPJ5Puy3A4=", + "dev": true, + "requires": { + "cli": "0.4.3", + "minimatch": "0.0.x" + }, + "dependencies": { + "lru-cache": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-1.0.6.tgz", + "integrity": "sha1-qlD5cEdCKsclQ72hd6nJ0BjZhFI=", + "dev": true + }, + "minimatch": { + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-0.0.5.tgz", + "integrity": "sha1-lrtJC707poNrv6wRGt91MBsVhN4=", + "dev": true, + "requires": { + "lru-cache": "~1.0.2" + } + } + } + }, "json-parse-better-errors": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", @@ -4310,6 +4369,15 @@ "integrity": "sha512-cI6CHzivIFESe8djiK3Wh90CtWQBxLwMem8x8S+2GSvCvFgoMuOKVlfJtQ/2v3Afg3wOnHl/+tXotEs8z5vOrg==", "dev": true }, + "nopt": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/nopt/-/nopt-1.0.10.tgz", + "integrity": "sha1-bd0hvSoxQXuScn3Vhfim83YI6+4=", + "dev": true, + "requires": { + "abbrev": "1" + } + }, "normalize-path": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", @@ -4384,6 +4452,24 @@ "mimic-fn": "^2.1.0" } }, + "optimist": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/optimist/-/optimist-0.6.0.tgz", + "integrity": "sha1-aUJIJvNAX3nxQub8PZrljU27kgA=", + "dev": true, + "requires": { + "minimist": "~0.0.1", + "wordwrap": "~0.0.2" + }, + "dependencies": { + "minimist": { + "version": "0.0.10", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.10.tgz", + "integrity": "sha1-3j+YVD2/lggr5IrRoMfNqDYwHc8=", + "dev": true + } + } + }, "optionator": { "version": "0.9.1", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", @@ -5261,6 +5347,65 @@ "strip-bom": "^3.0.0" } }, + "tsdoc": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/tsdoc/-/tsdoc-0.0.4.tgz", + "integrity": "sha1-+xmixqjuYdVfrQjWgQRXGe9CvsM=", + "dev": true, + "requires": { + "jsdoc": "3.2.0", + "optimist": "0.6.0" + }, + "dependencies": { + "catharsis": { + "version": "0.5.6", + "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.5.6.tgz", + "integrity": "sha1-IQoM+iPF0J+plNb6/hp2ODwXDLs=", + "dev": true + }, + "js2xmlparser": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-0.1.0.tgz", + "integrity": "sha1-GwTWez95Ow47Rvr26pxO9tnn8WI=", + "dev": true + }, + "jsdoc": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-3.2.0.tgz", + "integrity": "sha1-bziez4i18SZixR3eKZj1JkF4C8Q=", + "dev": true, + "requires": { + "async": "0.1.22", + "catharsis": "0.5.6", + "crypto-browserify": "git+https://github.com/dominictarr/crypto-browserify.git#95c5d505", + "js2xmlparser": "0.1.0", + "jshint": "0.9.1", + "markdown": "git+https://github.com/jsdoc3/markdown-js.git", + "marked": "0.2.8", + "taffydb": "git+https://github.com/hegemonic/taffydb.git", + "underscore": "1.4.2", + "wrench": "1.3.9" + } + }, + "marked": { + "version": "0.2.8", + "resolved": "https://registry.npmjs.org/marked/-/marked-0.2.8.tgz", + "integrity": "sha1-3dvMOO2BgraAqvnXzrvntiSXYHE=", + "dev": true + }, + "taffydb": { + "version": "git+https://github.com/hegemonic/taffydb.git#e41b5e179e197bb85c5fb887b707672b1e5ca079", + "from": "git+https://github.com/hegemonic/taffydb.git", + "dev": true + }, + "underscore": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.4.2.tgz", + "integrity": "sha1-yyquanmZqJ/VWq7nW84DEWmM6/s=", + "dev": true + } + } + }, "tslib": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", @@ -5659,6 +5804,12 @@ "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", "dev": true }, + "wrench": { + "version": "1.3.9", + "resolved": "https://registry.npmjs.org/wrench/-/wrench-1.3.9.tgz", + "integrity": "sha1-bxPsNRRTF+spLKX2UxORskQRFBE=", + "dev": true + }, "write-file-atomic": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", diff --git a/package.json b/package.json index e13254f..1e472be 100644 --- a/package.json +++ b/package.json @@ -17,6 +17,7 @@ }, "devDependencies": { "@jest/types": "^27.4.2", + "@microsoft/tsdoc": "^0.13.2", "@tsconfig/recommended": "^1.0.1", "@types/axios": "^0.14.0", "@types/is-my-json-valid": "^2.18.1",