diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 000000000..7d0cfaecb --- /dev/null +++ b/.eslintrc @@ -0,0 +1,34 @@ +{ + "extends": ["hardcore", "hardcore/ts", "hardcore/jest"], + "parser": "@typescript-eslint/parser", + "plugins": ["@typescript-eslint"], + "root": true, + "parserOptions": { + "project": ["./tsconfig.json", "./tsconfig.test.json"] + }, + "ignorePatterns": ["jest.config.cjs", "jest-stackblitz.config.cjs", "docs/*"], + "rules": { + "@typescript-eslint/quotes": [ + "error", + "single", + { + "allowTemplateLiterals": true + } + ], + "@typescript-eslint/parameter-properties": [ + "error", + { + "allow": ["public"] + } + ], + "jest/no-hooks": [ + "error", + { + "allow": ["beforeEach", "afterEach", "beforeAll", "afterAll"] + } + ], + "@typescript-eslint/consistent-indexed-object-style": "off", + "import/no-extraneous-dependencies": ["error", {"peerDependencies": true}] + + } +} diff --git a/.github/workflows/pull-request-develop.yml b/.github/workflows/pull-request-develop.yml new file mode 100644 index 000000000..dc2a824c7 --- /dev/null +++ b/.github/workflows/pull-request-develop.yml @@ -0,0 +1,93 @@ +# This workflow runs lint/test/build in parallel +# on every pull request to develop +# It also produces test coverage comments +name: 'Validate PRs to develop' +on: + # run on every pull request + pull_request: + # only for the following branches + branches: + - develop + +jobs: + # Installs npm dependencies for the first time, + # caching them in ~/.npm + install: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 18 + # This only caches ~/.npm, therefore each subsequent + # job needs to run `npm ci` to install deps from npm cache + # alternative is to cache `node_modules` directly + # TODO: + # https://www.voorhoede.nl/en/blog/super-fast-npm-install-on-github-actions/ + # Add caching of `node_modules` to speed up this workflow + cache: npm + + # install dependencies from the package-lock.json + - name: Install dependencies + run: npm ci --workspaces + + # builds all packages + build: + runs-on: ubuntu-latest + needs: install + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 18 + cache: npm + + - name: 'Install dependencies' + run: npm ci --workspaces --include-workspace-root + + - name: 'Build' + run: npm run build + + # lints all packages + lint: + runs-on: ubuntu-latest + needs: install + steps: + # check out the repository + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 18 + cache: npm + + - name: 'Install dependencies' + run: npm ci --workspaces --include-workspace-root + + - name: 'Build' + run: npm run build + + - name: 'Lint' + run: npm run lint + + # tests all packages + test: + runs-on: ubuntu-latest + needs: install + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 18 + cache: npm + + - name: 'Install dependencies' + run: npm ci --workspaces --include-workspace-root + + - name: 'Build' + run: npm run build + + - name: 'Reinstall monorepo packages' + run: npm ci --workspaces --include-workspace-root + + - name: 'Test' + run: npm run test:ci diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..381b77d11 --- /dev/null +++ b/.gitignore @@ -0,0 +1,40 @@ +# See http://help.github.com/ignore-files/ for more about ignoring files. + +# compiled output +dist +tmp +/out-tsc + +# dependencies +node_modules + +# IDEs and editors +/.idea +.project +.classpath +.c9/ +*.launch +.settings/ +*.sublime-workspace + +# IDE - VSCode +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json + +# misc +/.sass-cache +/connect.lock +/coverage +/libpeerconnection.log +npm-debug.log +yarn-error.log +testem.log +/typings + +# System Files +.DS_Store +Thumbs.db +lerna-debug.log \ No newline at end of file diff --git a/.husky/pre-commit b/.husky/pre-commit new file mode 100755 index 000000000..d24fdfc60 --- /dev/null +++ b/.husky/pre-commit @@ -0,0 +1,4 @@ +#!/usr/bin/env sh +. "$(dirname -- "$0")/_/husky.sh" + +npx lint-staged diff --git a/.husky/pre-push b/.husky/pre-push new file mode 100755 index 000000000..47a6fa1c5 --- /dev/null +++ b/.husky/pre-push @@ -0,0 +1,4 @@ +#!/usr/bin/env sh +. "$(dirname -- "$0")/_/husky.sh" + +npx branch-name-lint branch-name-lint.json \ No newline at end of file diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 000000000..d0b804da2 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,4 @@ +# Add files here to ignore them from prettier formatting + +/dist +/coverage diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 000000000..3baced411 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,4 @@ +{ + "singleQuote": true, + "endOfLine": "auto" +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 000000000..71f5e856b --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,3 @@ +{ + "recommendations": ["nrwl.angular-console", "esbenp.prettier-vscode"] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 000000000..5e38e1db4 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "js/ts.implicitProjectConfig.experimentalDecorators": true +} diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..685e2f971 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [2023] [Stove Labs] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/branch-name-lint.json b/branch-name-lint.json new file mode 100644 index 000000000..44908ff9e --- /dev/null +++ b/branch-name-lint.json @@ -0,0 +1,20 @@ +{ + "branchNameLinter": { + "prefixes": ["feature", "hotfix", "release"], + "suggestions": { + "features": "feature", + "feat": "feature", + "fix": "hotfix", + "releases": "release" + }, + "banned": ["wip"], + "skip": ["skip-ci"], + "disallowed": ["master", "develop", "staging"], + "separator": "/", + "msgBranchBanned": "Branches with the name \"%s\" are not allowed.", + "msgBranchDisallowed": "Pushing to \"%s\" is not allowed, use git-flow.", + "msgPrefixNotAllowed": "Branch prefix \"%s\" is not allowed.", + "msgPrefixSuggestion": "Instead of \"%s\" try \"%s\".", + "msgseparatorRequired": "Branch \"%s\" must contain a separator \"%s\"." + } +} diff --git a/jest.config.cjs b/jest.config.cjs new file mode 100644 index 000000000..a7861eb69 --- /dev/null +++ b/jest.config.cjs @@ -0,0 +1,24 @@ +/* eslint-disable no-undef */ +/* eslint-disable import/unambiguous */ +/* eslint-disable import/no-commonjs */ +/** @type {import('ts-jest').JestConfigWithTsJest} */ + +module.exports = { + // because we run tests from within ./packages// + rootDir: './../../', + extensionsToTreatAsEsm: ['.ts'], + moduleNameMapper: { + '../../../node_modules/snarkyjs/dist/(.*)': '/node_modules/snarkyjs/dist/$1', + '^(\\.{1,2}/.*)\\.js$': '$1', + }, + transform: { + // '^.+\\.[tj]sx?$' to process js/ts with `ts-jest` + // '^.+\\.m?[tj]sx?$' to process js/ts/mjs/mts with `ts-jest` + '^.+\\.tsx?$': [ + 'ts-jest', + { + useESM: true, + }, + ], + }, +}; diff --git a/lerna.json b/lerna.json new file mode 100644 index 000000000..ec0479c03 --- /dev/null +++ b/lerna.json @@ -0,0 +1,12 @@ +{ + "$schema": "node_modules/lerna/schemas/lerna-schema.json", + "useWorkspaces": true, + "version": "independent", + "independent": true, + "command": { + "publish": { + "conventionalCommits": true, + "message": "chore(release): release" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 000000000..b52228c73 --- /dev/null +++ b/package.json @@ -0,0 +1,49 @@ +{ + "name": "unknown", + "version": "0.0.0", + "license": "MIT", + "type": "module", + "scripts": { + "dev": "npx lerna run dev", + "build": "npx lerna run build", + "lint": "npx lerna run lint", + "lint:staged": "eslint", + "test": "npx lerna run test -- --passWithNoTests", + "test:ci": "npx lerna run test -- --passWithNoTests --forceExit", + "test:watch": "npx lerna run test:watch", + "commit": "cz", + "publish:canary": "npx lerna publish prerelease --no-private --exact --yes --canary --preid develop --dist-tag latest --loglevel verbose --force-git-tag --force-publish" + }, + "private": true, + "devDependencies": { + "@nrwl/nx-cloud": "latest", + "@types/jest": "^29.4.0", + "@typescript-eslint/eslint-plugin": "^5.49.0", + "@typescript-eslint/parser": "^5.49.0", + "commitizen": "^4.3.0", + "cz-conventional-changelog": "^3.3.0", + "eslint": "^8.32.0", + "eslint-config-hardcore": "^26.0.1", + "husky": "^8.0.3", + "jest": "^29.4.0", + "lerna": "^6.4.1", + "lint-staged": "^13.1.0", + "nx": "15.6.2", + "prettier": "^2.6.2", + "ts-jest": "^29.0.5", + "typescript": "^4.9.4" + }, + "workspaces": [ + "packages/**/*" + ], + "config": { + "commitizen": { + "path": "./node_modules/cz-conventional-changelog" + } + }, + "lint-staged": { + "*.ts": [ + "npm run lint:staged" + ] + }, +} diff --git a/packages/module/jest.config.cjs b/packages/module/jest.config.cjs new file mode 100644 index 000000000..234c3a875 --- /dev/null +++ b/packages/module/jest.config.cjs @@ -0,0 +1 @@ +module.exports = require('../../jest.config.cjs'); \ No newline at end of file diff --git a/packages/module/package.json b/packages/module/package.json new file mode 100644 index 000000000..47101d52e --- /dev/null +++ b/packages/module/package.json @@ -0,0 +1,19 @@ +{ + "name": "@unknown/module", + "version": "0.1.8", + "license": "MIT", + "private": false, + "type": "module", + "scripts": { + "build": "tsc -p tsconfig.json", + "dev": "tsc -p tsconfig.json --watch", + "lint": "eslint ./src", + "test": "node --experimental-vm-modules --experimental-wasm-modules --experimental-wasm-threads ../../node_modules/jest/bin/jest.js ./src", + "test:ci": "node --experimental-vm-modules --experimental-wasm-modules --experimental-wasm-threads ../../node_modules/jest/bin/jest.js ./src", + "test:watch": "node --experimental-vm-modules --experimental-wasm-modules --experimental-wasm-threads ../../node_modules/jest/bin/jest.js ./src --watch" + }, + "main": "dist/index.js", + "publishConfig": { + "access": "public" + } +} diff --git a/packages/module/src/index.ts b/packages/module/src/index.ts new file mode 100644 index 000000000..7c645e42f --- /dev/null +++ b/packages/module/src/index.ts @@ -0,0 +1 @@ +export default {}; \ No newline at end of file diff --git a/packages/module/tsconfig.json b/packages/module/tsconfig.json new file mode 100644 index 000000000..7e1bf2a1c --- /dev/null +++ b/packages/module/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "./../../tsconfig.json", + "compilerOptions": { + "outDir": "./dist" + }, + "include": ["./src/index.ts"], + "exclude": ["./dist/**/*.ts"] +} diff --git a/packages/module/tsconfig.test.json b/packages/module/tsconfig.test.json new file mode 100644 index 000000000..6f8322c29 --- /dev/null +++ b/packages/module/tsconfig.test.json @@ -0,0 +1,9 @@ +{ + "extends": "./../../tsconfig.json", + "include": [ + "./src/**/*.test.ts", + "./test/**/*.ts", + "./test/*.ts", + "./src/**/*.ts" + ] +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 000000000..3b22037d4 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "strictNullChecks": true, + "lib": ["es2020"], + "target": "ES2020", + "module": "ES2022", + "declaration": true, + "experimentalDecorators": true, + "emitDecoratorMetadata": true, + "moduleResolution": "nodenext", + "noImplicitAny": true, + "allowJs": true, + "esModuleInterop": true, + "strict": true, + "alwaysStrict": true, + "declarationMap": true + } +}