Skip to content

Commit cb67ea7

Browse files
cipchkcipchk
authored
chore: refactor build and test env (#72)
1 parent 68022d6 commit cb67ea7

30 files changed

+4604
-365
lines changed

‎.cssrem

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"fixedDigits": 3,
55
"vw": true,
66
"ignores": [
7-
"**/*.less",
8-
"*.tsx"
7+
// "**/*.less",
8+
// "*.tsx"
99
],
1010
"ignoresViaCommand": []
1111
}

‎.github/workflows/ci.yml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [main, master]
7+
8+
jobs:
9+
package:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-node@v4
14+
with:
15+
node-version-file: ".nvmrc"
16+
cache: "yarn"
17+
- uses: actions/cache@v3
18+
with:
19+
path: ./node_modules
20+
key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', '**/*.patch') }}
21+
- name: Install node modules
22+
run: yarn install --frozen-lockfile
23+
- run: npm run package
24+
25+
test:
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@v4
29+
- uses: actions/setup-node@v4
30+
with:
31+
node-version-file: ".nvmrc"
32+
cache: "yarn"
33+
- uses: actions/cache@v3
34+
with:
35+
path: ./node_modules
36+
key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', '**/*.patch') }}
37+
- name: Install node modules
38+
run: yarn install --frozen-lockfile
39+
- run: xvfb-run -a npm test
40+
if: runner.os == 'Linux'
41+
- run: npm test
42+
if: runner.os != 'Linux'
43+
44+
lint:
45+
runs-on: ubuntu-latest
46+
steps:
47+
- uses: actions/checkout@v4
48+
- uses: actions/setup-node@v4
49+
with:
50+
node-version-file: ".nvmrc"
51+
cache: "yarn"
52+
- uses: actions/cache@v3
53+
with:
54+
path: ./node_modules
55+
key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', '**/*.patch') }}
56+
- name: Install node modules
57+
run: yarn install --frozen-lockfile
58+
- run: npm run lint

‎.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
node_modules
33

44
*.vsix
5-
yarn.lock
5+
# yarn.lock
66

77
# Yarn
88
# yarn.lock
@@ -14,3 +14,6 @@ yarn-error.log
1414
!.yarn/sdks
1515
!.yarn/versions
1616
.pnp.*
17+
18+
.vscode/**
19+
.vscode-test/**

‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
18.19.1

‎.prettierrc

-23
This file was deleted.

‎.vscode-test.mjs

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import { defineConfig } from '@vscode/test-cli';
2+
3+
export default defineConfig({
4+
files: 'out/test/**/*.test.js',
5+
});

‎.vscode/launch.json

+13-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1+
// A launch configuration that compiles the extension and then opens it inside a new window
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
15
{
26
"version": "0.2.0",
37
"configurations": [
48
{
5-
"name": "Launch Extension",
9+
"name": "Run Extension",
610
"type": "extensionHost",
711
"request": "launch",
8-
"runtimeExecutable": "${execPath}",
9-
"args": ["--extensionDevelopmentPath=${workspaceRoot}"],
10-
"stopOnEntry": false,
11-
"sourceMaps": true,
12-
"preLaunchTask": "npm",
13-
"outFiles": ["${workspaceRoot}/out/**/*.js"]
12+
"args": [
13+
"--extensionDevelopmentPath=${workspaceFolder}"
14+
],
15+
"outFiles": [
16+
"${workspaceFolder}/dist/**/*.js"
17+
],
18+
"preLaunchTask": "${defaultBuildTask}"
1419
}
1520
]
16-
}
21+
}

‎.vscode/settings.json

+11-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,18 @@
22
"files.associations": {
33
".cssrem": "jsonc"
44
},
5+
"files.exclude": {
6+
"out": false, // set this to true to hide the "out" folder with the compiled JS files
7+
"dist": false // set this to true to hide the "dist" folder with the compiled JS files
8+
},
9+
"search.exclude": {
10+
"out": true, // set this to false to include "out" folder in search results
11+
"dist": true // set this to false to include "dist" folder in search results
12+
},
513
"editor.formatOnSave": true,
614
"[markdown]": {
715
"editor.formatOnSave": false
8-
}
16+
},
17+
// Turn off tsc task auto detection since we have the necessary tasks as npm scripts
18+
"typescript.tsc.autoDetect": "off"
919
}

‎.vscode/tasks.json

+58-14
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,64 @@
1-
// A task runner that calls a custom npm script that compiles the extension.
1+
// See https://go.microsoft.com/fwlink/?LinkId=733558
2+
// for the documentation about the tasks.json format
23
{
4+
"version": "2.0.0",
35
"tasks": [
46
{
5-
"taskName": "npm",
6-
// we want to run npm
7-
"command": "npm",
8-
// the command is a shell script
9-
"isShellCommand": true,
10-
// show the output window only if unrecognized errors occur.
11-
"showOutput": "silent",
12-
// we run the custom script "compile" as defined in package.json
13-
"args": ["run", "prod", "--loglevel", "silent"],
14-
// The tsc compiler is started in watching mode
7+
"label": "watch",
8+
"dependsOn": [
9+
"npm: watch:tsc",
10+
"npm: watch:esbuild"
11+
],
12+
"presentation": {
13+
"reveal": "never"
14+
},
15+
"group": {
16+
"kind": "build",
17+
"isDefault": true
18+
}
19+
},
20+
{
21+
"type": "npm",
22+
"script": "watch:esbuild",
23+
"group": "build",
24+
"problemMatcher": "$esbuild-watch",
25+
"isBackground": true,
26+
"label": "npm: watch:esbuild",
27+
"presentation": {
28+
"group": "watch",
29+
"reveal": "never"
30+
}
31+
},
32+
{
33+
"type": "npm",
34+
"script": "watch:tsc",
35+
"group": "build",
36+
"problemMatcher": "$tsc-watch",
1537
"isBackground": true,
16-
// use the standard tsc in watch mode problem matcher to find compile problems in the output.
17-
"problemMatcher": "$tsc-watch"
38+
"label": "npm: watch:tsc",
39+
"presentation": {
40+
"group": "watch",
41+
"reveal": "never"
42+
}
43+
},
44+
{
45+
"type": "npm",
46+
"script": "watch-tests",
47+
"problemMatcher": "$tsc-watch",
48+
"isBackground": true,
49+
"presentation": {
50+
"reveal": "never",
51+
"group": "watchers"
52+
},
53+
"group": "build"
54+
},
55+
{
56+
"label": "tasks: watch-tests",
57+
"dependsOn": [
58+
"npm: watch",
59+
"npm: watch-tests"
60+
],
61+
"problemMatcher": []
1862
}
1963
]
20-
}
64+
}

‎.vscodeignore

+13-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
.vscode/**
22
.vscode-test/**
3-
out/test/**
4-
test/**
53
src/**
6-
**/*.map
74
.gitignore
8-
tsconfig.json
5+
.yarnrc
6+
esbuild.js
97
vsc-extension-quickstart.md
8+
**/tsconfig.json
9+
**/eslint.config.mjs
10+
**/*.map
11+
**/*.ts
12+
**/.vscode-test.*
13+
.github/**
14+
.yarn/**
15+
examples/**
16+
demo.gif
17+
.cssrem
18+
.yarnrc.yml

‎esbuild.js

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
const esbuild = require('esbuild');
2+
3+
const production = process.argv.includes('--production');
4+
const watch = process.argv.includes('--watch');
5+
6+
/**
7+
* @type {import('esbuild').Plugin}
8+
*/
9+
const esbuildProblemMatcherPlugin = {
10+
name: 'esbuild-problem-matcher',
11+
12+
setup(build) {
13+
build.onStart(() => {
14+
console.log('[watch] build started');
15+
});
16+
build.onEnd(result => {
17+
result.errors.forEach(({ text, location }) => {
18+
console.error(`✘ [ERROR] ${text}`);
19+
console.error(` ${location.file}:${location.line}:${location.column}:`);
20+
});
21+
console.log('[watch] build finished');
22+
});
23+
},
24+
};
25+
26+
async function main() {
27+
const ctx = await esbuild.context({
28+
entryPoints: ['src/extension.ts'],
29+
bundle: true,
30+
format: 'cjs',
31+
minify: production,
32+
sourcemap: !production,
33+
sourcesContent: false,
34+
platform: 'node',
35+
outfile: 'out/extension.js',
36+
mainFields: ['module', 'main'],
37+
external: ['vscode'],
38+
logLevel: 'silent',
39+
plugins: [
40+
/* add to the end of plugins array */
41+
esbuildProblemMatcherPlugin,
42+
],
43+
});
44+
if (watch) {
45+
await ctx.watch();
46+
} else {
47+
await ctx.rebuild();
48+
await ctx.dispose();
49+
}
50+
}
51+
52+
main().catch(e => {
53+
console.error(e);
54+
process.exit(1);
55+
});

‎eslint.config.mjs

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
import typescriptEslint from '@typescript-eslint/eslint-plugin';
2+
import tsParser from '@typescript-eslint/parser';
3+
4+
export default [
5+
{
6+
files: ['**/*.ts'],
7+
},
8+
{
9+
plugins: {
10+
'@typescript-eslint': typescriptEslint,
11+
},
12+
13+
languageOptions: {
14+
parser: tsParser,
15+
ecmaVersion: 2022,
16+
sourceType: 'module',
17+
},
18+
19+
rules: {
20+
'@typescript-eslint/naming-convention': [
21+
'warn',
22+
{
23+
selector: 'import',
24+
format: ['camelCase', 'PascalCase'],
25+
},
26+
],
27+
28+
// curly: "warn",
29+
// eqeqeq: "warn",
30+
'no-throw-literal': 'warn',
31+
semi: 'warn',
32+
},
33+
},
34+
];

0 commit comments

Comments
 (0)