Skip to content

Commit 53f26f4

Browse files
JoseLionJoseLion
authored
feat(core): Project bootstrap (#1)
1 parent 196f007 commit 53f26f4

File tree

20 files changed

+9907
-0
lines changed

20 files changed

+9907
-0
lines changed

‎.eslintignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Dependencies
2+
.yarn/
3+
node_modules/
4+
5+
# Auto-generated
6+
build/
7+
dist/

‎.eslintrc.json‎

Lines changed: 229 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,229 @@
1+
{
2+
"root": true,
3+
"env": {
4+
"es6": true,
5+
"node": true
6+
},
7+
"settings": {
8+
"import/resolver": {
9+
"typescript": {
10+
"alwaysTryTypes": true,
11+
"project": "./tsconfig.json"
12+
}
13+
}
14+
},
15+
"parserOptions": {
16+
"ecmaVersion": "latest",
17+
"project": "./tsconfig.json",
18+
"sourceType": "module"
19+
},
20+
"plugins": [
21+
"@typescript-eslint",
22+
"eslint-plugin-import",
23+
"eslint-plugin-jsdoc",
24+
"etc",
25+
"sonarjs"
26+
],
27+
"extends": [
28+
"eslint:recommended",
29+
"plugin:@typescript-eslint/recommended",
30+
"plugin:@typescript-eslint/recommended-requiring-type-checking",
31+
"plugin:etc/recommended",
32+
"plugin:import/typescript",
33+
"plugin:sonarjs/recommended"
34+
],
35+
"overrides": [{
36+
"files": "*.ts?(x)",
37+
"parser": "@typescript-eslint/parser"
38+
}, {
39+
"files": "*.test.ts?(x)",
40+
"rules": {
41+
"@typescript-eslint/no-non-null-assertion": "off",
42+
"@typescript-eslint/restrict-template-expressions": "off",
43+
"etc/throw-error": "off",
44+
"import/no-namespace": "off"
45+
}
46+
}, {
47+
"files": "*.typetest.ts?(x)",
48+
"rules": {
49+
"@typescript-eslint/ban-ts-comment": ["error", { "ts-expect-error": false }],
50+
"etc/throw-error": "off",
51+
"import/no-namespace": "off"
52+
}
53+
}, {
54+
"files": "*.js?(x)",
55+
"rules": {
56+
"@typescript-eslint/explicit-function-return-type": "off",
57+
"@typescript-eslint/explicit-member-accessibility": "off",
58+
"@typescript-eslint/explicit-module-boundary-types": "off",
59+
"@typescript-eslint/no-unsafe-argument": "off",
60+
"@typescript-eslint/no-unsafe-assignment": "off",
61+
"@typescript-eslint/no-unsafe-member-access": "off",
62+
"@typescript-eslint/no-unsafe-call": "off",
63+
"@typescript-eslint/no-unsafe-return": "off",
64+
"@typescript-eslint/no-var-requires": "off",
65+
"@typescript-eslint/restrict-plus-operands": "off",
66+
"@typescript-eslint/restrict-template-expressions": "off"
67+
}
68+
}],
69+
"rules": {
70+
"@typescript-eslint/ban-types": "error",
71+
"@typescript-eslint/comma-dangle": ["error", "always-multiline"],
72+
"@typescript-eslint/consistent-type-assertions": "error",
73+
"@typescript-eslint/dot-notation": "error",
74+
"@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }],
75+
"@typescript-eslint/explicit-member-accessibility": "error",
76+
"@typescript-eslint/explicit-module-boundary-types": "error",
77+
"@typescript-eslint/member-ordering": ["error", {
78+
"classes": [
79+
"static-field",
80+
"field",
81+
"constructor",
82+
"static-method",
83+
"abstract-method",
84+
"protected-method",
85+
"public-method",
86+
"private-method"
87+
],
88+
"interfaces": { "order": "alphabetically" },
89+
"typeLiterals": { "order": "alphabetically" }
90+
}],
91+
"@typescript-eslint/member-delimiter-style": ["error", {
92+
"multiline": {
93+
"delimiter": "semi",
94+
"requireLast": true
95+
},
96+
"singleline": {
97+
"delimiter": "semi",
98+
"requireLast": true
99+
}
100+
}],
101+
"@typescript-eslint/no-empty-function": "error",
102+
"@typescript-eslint/no-empty-interface": "error",
103+
"@typescript-eslint/no-explicit-any": ["error", { "ignoreRestArgs": true }],
104+
"@typescript-eslint/no-floating-promises": "off",
105+
"@typescript-eslint/no-inferrable-types": ["error", {
106+
"ignoreParameters": true,
107+
"ignoreProperties": true
108+
}],
109+
"@typescript-eslint/no-misused-new": "error",
110+
"@typescript-eslint/no-namespace": "off",
111+
"@typescript-eslint/no-non-null-assertion": "error",
112+
"@typescript-eslint/no-redundant-type-constituents": "error",
113+
"@typescript-eslint/no-shadow": ["error", { "hoist": "all" }],
114+
"@typescript-eslint/no-unused-expressions": ["error", { "allowTernary": true }],
115+
"@typescript-eslint/no-unused-vars": ["error", {
116+
"destructuredArrayIgnorePattern": "^_",
117+
"ignoreRestSiblings": true
118+
}],
119+
"@typescript-eslint/no-use-before-define": ["error", {
120+
"functions": false,
121+
"classes": false
122+
}],
123+
"@typescript-eslint/no-var-requires": "error",
124+
"@typescript-eslint/parameter-properties": "error",
125+
"@typescript-eslint/prefer-for-of": "error",
126+
"@typescript-eslint/prefer-function-type": "error",
127+
"@typescript-eslint/prefer-namespace-keyword": "error",
128+
"@typescript-eslint/quotes": ["error", "double", {
129+
"avoidEscape": true,
130+
"allowTemplateLiterals": false
131+
}],
132+
"@typescript-eslint/restrict-template-expressions": ["error", {
133+
"allowNumber": true,
134+
"allowBoolean": true,
135+
"allowNullish": true
136+
}],
137+
"@typescript-eslint/semi": "error",
138+
"@typescript-eslint/space-infix-ops": "error",
139+
"@typescript-eslint/triple-slash-reference": "error",
140+
"@typescript-eslint/type-annotation-spacing": "error",
141+
"@typescript-eslint/unbound-method": ["error", { "ignoreStatic": true }],
142+
"@typescript-eslint/unified-signatures": "error",
143+
"array-bracket-spacing": "error",
144+
"arrow-parens": ["error", "as-needed"],
145+
"arrow-spacing": "error",
146+
"brace-style": "error",
147+
"camelcase": "error",
148+
"comma-spacing": "error",
149+
"computed-property-spacing": "error",
150+
"constructor-super": "error",
151+
"curly": "error",
152+
"etc/no-commented-out-code": "error",
153+
"etc/throw-error": "error",
154+
"eol-last": "error",
155+
"eqeqeq": "error",
156+
"func-style": ["error", "declaration", { "allowArrowFunctions": true }],
157+
"import/newline-after-import": "error",
158+
"import/no-absolute-path": "error",
159+
"import/no-cycle": ["error", {
160+
"allowUnsafeDynamicCyclicDependency": true,
161+
"ignoreExternal": true
162+
}],
163+
"import/no-duplicates": "error",
164+
"import/no-import-module-exports": "error",
165+
"import/no-namespace": "error",
166+
"import/no-relative-packages": "error",
167+
"import/no-unresolved": "error",
168+
"import/no-useless-path-segments": "error",
169+
"import/order": ["error", {
170+
"alphabetize": {
171+
"caseInsensitive": false,
172+
"order": "asc"
173+
},
174+
"newlines-between": "always",
175+
"groups": ["external", "parent", "sibling"]
176+
}],
177+
"jsdoc/check-alignment": "error",
178+
"jsdoc/check-indentation": ["error", { "excludeTags": ["example", "param", "returns"] }],
179+
"jsdoc/tag-lines": ["error", "any", { "startLines": 1 }],
180+
"keyword-spacing": "error",
181+
"linebreak-style": "error",
182+
"max-classes-per-file": ["error", 1],
183+
"max-len": ["error", {
184+
"code": 120,
185+
"comments": 80,
186+
"ignoreRegExpLiterals": true,
187+
"ignorePattern": "^import (\\{ )?\\w+( \\})? from \".+\";$",
188+
"ignoreUrls": true,
189+
"tabWidth": 2
190+
}],
191+
"new-parens": "error",
192+
"no-caller": "error",
193+
"no-cond-assign": "error",
194+
"no-console": "error",
195+
"no-duplicate-imports": "error",
196+
"no-empty-function": "error",
197+
"no-eval": "error",
198+
"no-extra-boolean-cast": ["error", { "enforceForLogicalOperands": true }],
199+
"no-invalid-this": "error",
200+
"no-labels": "error",
201+
"no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 0, "maxBOF": 0 }],
202+
"no-multi-spaces": "error",
203+
"no-new-wrappers": "error",
204+
"no-param-reassign": "error",
205+
"no-tabs": "error",
206+
"no-throw-literal": "error",
207+
"no-trailing-spaces": "error",
208+
"no-underscore-dangle": "error",
209+
"no-use-before-define": "off",
210+
"no-useless-computed-key": ["error", { "enforceForClassMembers": true }],
211+
"no-var": "error",
212+
"object-curly-spacing": ["error", "always"],
213+
"object-shorthand": "error",
214+
"one-var": ["error", "never"],
215+
"prefer-const": "error",
216+
"quote-props": ["error", "as-needed"],
217+
"radix": "error",
218+
"rest-spread-spacing": "error",
219+
"semi-spacing": "error",
220+
"sonarjs/cognitive-complexity": "off",
221+
"sonarjs/no-duplicate-string": "off",
222+
"sonarjs/no-inverted-boolean-check": "error",
223+
"sort-keys": "error",
224+
"space-before-blocks": "error",
225+
"space-in-parens": "error",
226+
"spaced-comment": "error",
227+
"switch-colon-spacing": "error"
228+
}
229+
}

‎.github/workflows/ci.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
workflow_call:
8+
9+
concurrency:
10+
group: ci-${{ github.ref_name }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
build:
15+
runs-on: ubuntu-latest
16+
strategy:
17+
matrix:
18+
nodejs: [18, 19, 20, 21]
19+
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: actions/setup-node@v4
23+
with:
24+
node-version: ${{ matrix.nodejs }}
25+
cache: yarn
26+
- run: yarn install --immutable
27+
- run: yarn compile
28+
- run: yarn lint
29+
- run: yarn test

‎.github/workflows/codeql.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: CodeQL
2+
3+
on:
4+
push:
5+
branches: main
6+
pull_request:
7+
branches: main
8+
schedule:
9+
- cron: 23 2 * * 0
10+
11+
concurrency:
12+
group: codeql-${{ github.ref_name }}
13+
cancel-in-progress: true
14+
15+
jobs:
16+
analyze:
17+
runs-on: ubuntu-latest
18+
timeout-minutes: 360
19+
permissions:
20+
actions: read
21+
contents: read
22+
security-events: write
23+
24+
steps:
25+
- uses: actions/checkout@v4
26+
- uses: actions/setup-node@v4
27+
with:
28+
node-version-file: .nvmrc
29+
cache: yarn
30+
- uses: github/codeql-action/init@v2
31+
with:
32+
languages: javascript-typescript
33+
- uses: github/codeql-action/analyze@v2
34+
with:
35+
category: /language:javascript-typescript

‎.github/workflows/owner-approve.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Auto approve for owner
2+
3+
on:
4+
pull_request:
5+
types: [opened, reopened]
6+
7+
jobs:
8+
approve:
9+
if: github.actor == github.repository_owner
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: hmarr/auto-approve-action@v3
13+
with:
14+
github-token: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Node.js
2+
node_modules/
3+
.yarn/*
4+
!.yarn/patches
5+
!.yarn/plugins
6+
!.yarn/releases
7+
!.yarn/sdks
8+
!.yarn/versions
9+
10+
# Generated
11+
build/
12+
dist/
13+
14+
# VSCode
15+
.vscode/
16+
17+
# Logs
18+
*.log

‎.mocharc.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"$schema": "https://json.schemastore.org/mocharc",
3+
"exit": true,
4+
"extension": ["ts", "tsx"],
5+
"recursive": true,
6+
"require": [
7+
"ts-node/register",
8+
"test/hooks.ts"
9+
],
10+
"spec": ["test/**/*.test.*"]
11+
}

‎.nvmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
21.5.0

‎.yarn/plugins/@yarnpkg/plugin-engines.cjs‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/* eslint-disable */
2+
//prettier-ignore
3+
module.exports = {
4+
name: "@yarnpkg/plugin-engines",
5+
factory: function (require) {
6+
var plugin=(()=>{var P=Object.create,f=Object.defineProperty;var R=Object.getOwnPropertyDescriptor;var N=Object.getOwnPropertyNames;var j=Object.getPrototypeOf,Y=Object.prototype.hasOwnProperty;var b=n=>f(n,"__esModule",{value:!0});var i=n=>{if(typeof require!="undefined")return require(n);throw new Error('Dynamic require of "'+n+'" is not supported')};var T=(n,e)=>{for(var r in e)f(n,r,{get:e[r],enumerable:!0})},V=(n,e,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let t of N(e))!Y.call(n,t)&&t!=="default"&&f(n,t,{get:()=>e[t],enumerable:!(r=R(e,t))||r.enumerable});return n},s=n=>V(b(f(n!=null?P(j(n)):{},"default",n&&n.__esModule&&"default"in n?{get:()=>n.default,enumerable:!0}:{value:n,enumerable:!0})),n);var U={};T(U,{default:()=>q});var o=s(i("@yarnpkg/core")),c;(function(r){r.Yarn="Yarn",r.Console="Console"})(c||(c={}));var h=class{constructor(e){this.throwWrongEngineError=(e,r)=>{let t=this.formatErrorMessage(e,r);this.throwError(t)};this.throwError=e=>{switch(this.errorReporter){case c.Yarn:this.reportYarnError(e);break;case c.Console:default:this.reportConsoleError(e);break}};this.reportYarnError=e=>{throw new o.ReportError(o.MessageName.UNNAMED,e)};this.reportConsoleError=e=>{console.error(e),process.exit(1)};this.formatErrorMessage=(e,r)=>{let{configuration:t}=this.project,p=o.formatUtils.applyStyle(t,o.formatUtils.pretty(t,this.engine,"green"),2),g=o.formatUtils.pretty(t,e,"cyan"),d=o.formatUtils.pretty(t,r,"cyan"),w=`The current ${p} version ${g} does not satisfy the required version ${d}.`;return o.formatUtils.pretty(t,w,"red")};this.project=e.project,this.errorReporter=e.errorReporter}};var m=s(i("fs")),y=s(i("path")),l=s(i("semver")),k=s(i("@yarnpkg/fslib")),a=s(i("@yarnpkg/core"));var v=class extends h{constructor(){super(...arguments);this.resolveNvmRequiredVersion=()=>{let{configuration:e,cwd:r}=this.project,t=(0,y.resolve)(k.npath.fromPortablePath(r),".nvmrc"),p=a.formatUtils.applyStyle(e,a.formatUtils.pretty(e,this.engine,"green"),2);if(!(0,m.existsSync)(t)){this.throwError(a.formatUtils.pretty(e,`Unable to verify the ${p} version. The .nvmrc file does not exist.`,"red"));return}let g=(0,m.readFileSync)(t,"utf-8").trim();if((0,l.validRange)(g))return g;let d=a.formatUtils.pretty(e,".nvmrc","yellow");this.throwError(a.formatUtils.pretty(e,`Unable to verify the ${p} version. The ${d} file contains an invalid semver range.`,"red"))}}get engine(){return"Node"}verifyEngine(e){let r=e.node;r!=null&&(r===".nvmrc"&&(r=this.resolveNvmRequiredVersion()),(0,l.satisfies)(process.version,r,{includePrerelease:!0})||this.throwWrongEngineError(process.version.replace(/^v/i,""),r.replace(/^v/i,"")))}};var x=s(i("semver")),E=s(i("@yarnpkg/core"));var u=class extends h{get engine(){return"Yarn"}verifyEngine(e){let r=e.yarn;r!=null&&((0,x.satisfies)(E.YarnVersion,r,{includePrerelease:!0})||this.throwWrongEngineError(E.YarnVersion,r))}};var C=n=>e=>{if(process.env.PLUGIN_YARN_ENGINES_DISABLE!=null)return;let{engines:r={}}=e.getWorkspaceByCwd(e.cwd).manifest.raw,t={project:e,errorReporter:n};[new v(t),new u(t)].forEach(g=>g.verifyEngine(r))},S={hooks:{validateProject:C(c.Yarn),setupScriptEnvironment:C(c.Console)}},q=S;return U;})();
7+
return plugin;
8+
}
9+
};

0 commit comments

Comments
 (0)