forked from dept/easy-genomics
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.projenrc.ts
More file actions
542 lines (524 loc) · 18 KB
/
Copy path.projenrc.ts
File metadata and controls
542 lines (524 loc) · 18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
import { awscdk, javascript, typescript, LicenseOptions } from 'projen';
import {
ArrowParens,
HTMLWhitespaceSensitivity,
JestOptions,
PrettierOptions,
ProseWrap,
QuoteProps,
TrailingComma,
TypescriptConfigExtends,
TypescriptConfigOptions,
} from 'projen/lib/javascript';
import { pathsToModuleNameMapper } from 'ts-jest';
import { ApacheLicense } from './projenrc/apache-license';
import { setupProjectFolders } from './projenrc/easy-genomics-project-setup';
import { GithubActionsCICDRelease } from './projenrc/github-actions-cicd-release';
import { Husky } from './projenrc/husky';
import { Nx } from './projenrc/nx';
import { PnpmWorkspace } from './projenrc/pnpm';
import { VscodeSettings } from './projenrc/vscode';
const defaultReleaseBranch = 'main';
const cdkVersion = '2.176.0';
const nodeVersion = '20.15.0';
const pnpmVersion = '9.15.0';
const authorName = 'DEPT Agency';
const copyrightOwner = authorName;
const copyrightPeriod = `${new Date().getFullYear()}`;
const prettierOptions: PrettierOptions = {
settings: {
printWidth: 120,
tabWidth: 2,
singleQuote: true,
semi: true,
trailingComma: TrailingComma.ALL,
arrowParens: ArrowParens.ALWAYS,
bracketSpacing: true,
htmlWhitespaceSensitivity: HTMLWhitespaceSensitivity.IGNORE,
proseWrap: ProseWrap.ALWAYS,
quoteProps: QuoteProps.PRESERVE,
useTabs: false,
vueIndentScriptAndStyle: true,
bracketSameLine: false,
plugins: ['prettier-plugin-tailwindcss'],
},
ignoreFileOptions: {
// add any Projen ready-only generated config files here
ignorePatterns: [
'.eslintrc.json',
'.github/pull_request_template.md',
'.prettierrc.json',
'.vscode/settings.json',
'nx.json',
'.eslintrc.json',
'cdk.json',
'cdk.out/',
'tsconfig*.json',
'*.d.ts',
],
},
};
// Changing compiler options will require that you re-run projen twice.
// As the jestConfig is reliant on the current (pre-projen run) version of ./tsconfig.json
const eslintGlobalRules = {
'no-unused-vars': 'off',
'@typescript-eslint/no-unused-vars': ['error'],
'semi': ['error', 'always'],
'comma-dangle': ['error', 'always-multiline'],
'space-before-function-paren': 'off',
'no-console': 'off',
'arrow-parens': ['error', 'always'],
'no-new': 'off',
'no-empty': 'error',
'prettier/prettier': 'off',
'require-await': 'off',
'array-callback-return': 'error',
'@typescript-eslint/indent': 'off',
};
const tsConfigOptions: TypescriptConfigOptions = {
compilerOptions: {
baseUrl: '.',
rootDir: '.',
// Add '@App/' as a path import alias for '<rootDir>/src/app/'
lib: ['ES2022'],
module: 'CommonJS',
target: 'ES2022',
declaration: true,
esModuleInterop: true,
forceConsistentCasingInFileNames: true,
skipLibCheck: true,
noImplicitAny: true,
strict: true,
paths: {
'@/*': ['../../*'],
'@BE/*': ['packages/back-end/src/app/*'],
'@FE/*': ['packages/front-end/src/app/*'],
'@SharedLib/*': ['packages/shared-lib/src/app/*'],
},
// noUnusedLocals: false,
},
include: ['packages/back-end/src/**/*.ts', 'packages/front-end/src/**/*.ts', 'packages/shared-lib/src/**/*.ts'],
exclude: [],
};
const jestOptions: JestOptions = {
jestConfig: {
// Add all the special paths to let Jest resolve them properly
moduleNameMapper: {
...(tsConfigOptions.compilerOptions?.paths
? pathsToModuleNameMapper(tsConfigOptions.compilerOptions?.paths, {
prefix: '<rootDir>/',
})
: {}),
},
coveragePathIgnorePatterns: ['/node_modules/'],
},
junitReporting: false,
extraCliOptions: ['--detectOpenHandles'],
};
const licenseOptions: LicenseOptions = {
spdx: 'Apache-2.0',
copyrightOwner: copyrightOwner,
copyrightPeriod: copyrightPeriod,
};
const root = new typescript.TypeScriptProject({
authorName: authorName,
authorOrganization: true,
defaultReleaseBranch: defaultReleaseBranch,
description:
'Easy Genomics web application to help simplify genomic analysis of sequenced genetic data for bioinformaticians utilizing AWS HealthOmics & NextFlow Tower',
eslint: true,
jest: true,
jestOptions: jestOptions,
githubOptions: {
pullRequestLintOptions: {
semanticTitle: true,
semanticTitleOptions: {
types: ['feat', 'fix', 'hotfix', 'release', 'refactor', 'chore', 'docs', 'infra'],
},
},
},
homepage: 'https://github.com/twobulls/easy-genomics',
licensed: false, // we apply the Apache 2.0 license later
minNodeVersion: nodeVersion,
name: '@easy-genomics/root',
packageManager: javascript.NodePackageManager.PNPM,
prettier: true,
prettierOptions,
projenCommand: 'pnpm dlx projen',
projenrcTs: true,
sampleCode: false,
tsconfig: tsConfigOptions,
// Disable default github actions workflows generated
// by projen as we will generate our own later (that uses nx)
depsUpgradeOptions: { workflow: false },
buildWorkflow: false,
pullRequestTemplate: false,
release: false,
devDeps: [
'@aws-sdk/types',
'@commitlint/cli',
'@commitlint/config-conventional',
'@commitlint/cz-commitlint',
'@types/aws-lambda',
'@types/uuid',
'@typescript-eslint/eslint-plugin@^7',
'@typescript-eslint/parser@^7',
'aws-sdk-client-mock',
'aws-sdk-client-mock-jest',
'cz-conventional-changelog',
// eslint 9 is a breaking change: https://github.com/projen/projen/issues/3950#issuecomment-2481314810
'eslint@^8',
'eslint-plugin-prettier',
'husky',
'lint-staged',
'validate-branch-name',
'prettier',
],
});
// Apply the global ESLint rules to the root project
if (root.eslint) {
root.eslint.addRules({ ...eslintGlobalRules });
root.eslint.addOverride({
files: ['packages/*/src/**/*.{js,ts,vue}'],
rules: {
'import/no-extraneous-dependencies': 'off',
},
});
root.eslint.addPlugins('prettier');
root.eslint.addExtends('plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended');
}
root.removeScript('build');
root.addScripts({
// Development convenience scripts
['build-back-end']:
'pnpm nx run-many --targets=build --projects=@easy-genomics/shared-lib,@easy-genomics/back-end --verbose=true',
['build-front-end']:
'nx reset && pnpm nx run-many --targets=build --projects=@easy-genomics/shared-lib,@easy-genomics/front-end --verbose=true',
['build-and-deploy']:
'pnpm nx run-many --targets=build --projects=@easy-genomics/shared-lib,@easy-genomics/back-end --verbose=true && ' +
'pnpm nx run-many --targets=deploy --projects=@easy-genomics/back-end --verbose=true && ' +
'pnpm nx run-many --targets=build --projects=@easy-genomics/shared-lib,@easy-genomics/front-end --verbose=true && ' +
'pnpm nx run-many --targets=deploy --projects=@easy-genomics/front-end --verbose=true',
['prettier']: "prettier --write '{**/*,*}.{js,ts,vue,scss,json,md,html,mdx}'",
['upgrade']:
'pnpm dlx projen upgrade && ' +
'pnpm nx run-many --targets=upgrade --projects=@easy-genomics/shared-lib,@easy-genomics/back-end,@easy-genomics/front-end',
// CI/CD convenience scripts
['cicd-build-deploy-back-end']:
'export CI_CD=true && ' +
'pnpm nx run-many --targets=build --projects=@easy-genomics/shared-lib,@easy-genomics/back-end --verbose=true && ' +
'pnpm nx run-many --targets=deploy --projects=@easy-genomics/back-end --verbose=true',
['cicd-build-deploy-front-end']:
'export CI_CD=true && ' +
'pnpm nx run-many --targets=build --projects=@easy-genomics/shared-lib,@easy-genomics/front-end --verbose=true && ' +
'pnpm nx run-many --targets=deploy --projects=@easy-genomics/front-end --verbose=true',
['prepare']: 'husky || true', // Enable Husky each time projen is synthesized
['projen']: 'nx reset; pnpm dlx projen', // Clear NX cache each time projen is synthesized to avoid cache disk-space overconsumption
['pre-commit']: 'lint-staged',
});
root.addFields({
'lint-staged': {
'{**/*,*}.{js,ts,vue,scss,json,md,html,mdx}': ['prettier --write'],
'packages/front-end/src/**/*.{js,ts}': ['pnpm --prefix packages/front-end run lint'],
'packages/back-end/src/**/*.{js,ts}': ['pnpm --prefix packages/back-end run lint'],
'packages/shared-lib/src/**/*.{js,ts}': ['pnpm --prefix packages/shared-lib run lint'],
},
});
// Defines the Easy Genomics 'shared-lib' subproject
const sharedLib = new typescript.TypeScriptProject({
parent: root,
name: '@easy-genomics/shared-lib',
outdir: './packages/shared-lib',
defaultReleaseBranch: defaultReleaseBranch,
docgen: false,
sampleCode: false,
authorName: authorName,
authorOrganization: true,
licensed: false, // we apply the Apache 2.0 license later
// Use same settings from root project
packageManager: root.package.packageManager,
projenCommand: root.projenCommand,
minNodeVersion: root.minNodeVersion,
deps: [
'@aws-sdk/client-api-gateway',
'@aws-sdk/client-cognito-identity-provider',
'@aws-sdk/client-omics',
'@aws-sdk/client-s3',
'@nestjs/config',
'aws-cdk',
'aws-cdk-lib',
'aws-lambda',
'js-yaml',
'uuid',
'zod',
],
devDeps: ['@types/aws-lambda', '@types/js-yaml', '@types/uuid', 'aws-cdk-lib', 'openapi-typescript'],
tsconfig: {
...tsConfigOptions,
compilerOptions: {
baseUrl: '.',
paths: {
'@BE/*': ['../packages/back-end/src/app/*'],
'@FE/*': ['../packages/front-end/src/app/*'],
'@SharedLib/*': ['src/app/*'],
},
},
},
});
sharedLib.addScripts({
['lint']: "eslint 'src/**/*.{js,ts}' --fix",
});
if (sharedLib.eslint) {
sharedLib.eslint.addRules({ ...eslintGlobalRules });
sharedLib.eslint.addPlugins('prettier');
}
// Defines the Easy Genomics 'back-end' subproject
const backEndApp = new awscdk.AwsCdkTypeScriptApp({
parent: root,
name: '@easy-genomics/back-end',
outdir: './packages/back-end',
cdkVersion: cdkVersion,
defaultReleaseBranch: defaultReleaseBranch,
docgen: false,
eslint: true,
lambdaAutoDiscover: false,
requireApproval: awscdk.ApprovalLevel.NEVER,
sampleCode: false,
authorName: authorName,
authorOrganization: true,
licensed: false, // we apply the Apache 2.0 license later
packageManager: root.package.packageManager,
projenCommand: root.projenCommand,
minNodeVersion: root.minNodeVersion,
tsconfig: {
...tsConfigOptions,
compilerOptions: {
baseUrl: '.',
paths: {
'@BE/*': ['src/app/*'],
'@FE/*': ['../packages/front-end/src/app/*'],
'@SharedLib/*': ['../packages/shared-lib/src/app/*'],
},
},
},
deps: [
'@aws-crypto/client-node',
'@aws-crypto/decrypt-node',
'@aws-crypto/encrypt-node',
'@aws-sdk/client-cognito-identity-provider',
'@aws-sdk/client-dynamodb',
'@aws-sdk/client-omics',
'@aws-sdk/client-ses',
'@aws-sdk/client-sns',
'@aws-sdk/client-sqs',
'@aws-sdk/client-ssm',
'@aws-sdk/client-sso-oidc',
'@aws-sdk/client-sts',
'@aws-sdk/client-s3',
'@aws-sdk/lib-dynamodb',
'@aws-sdk/s3-request-presigner',
'@aws-sdk/types',
'@aws-sdk/util-dynamodb',
'@easy-genomics/shared-lib@workspace:*',
'aws-cdk-lib',
'aws-lambda',
'base64-js',
'cdk-nag',
'dotenv',
'jsonwebtoken',
'uuid',
],
devDeps: [
'@aws-sdk/types',
'@types/aws-lambda',
'@types/jsonwebtoken',
'@types/node',
'@types/uuid',
'aws-sdk-client-mock',
'prettier',
'eslint-plugin-prettier',
],
});
backEndApp.addScripts({
['cdk-audit']: 'export CDK_AUDIT=true && pnpm dlx projen build',
['build']: 'pnpm dlx projen compile && pnpm dlx projen test && pnpm dlx projen build',
['deploy']: 'pnpm cdk bootstrap && pnpm dlx projen deploy',
['build-and-deploy']: 'pnpm -w run build-back-end && pnpm run deploy --require-approval any-change', // Run root build-back-end script to inc shared-lib
['lint']: "eslint 'src/**/*.{js,ts}' --fix",
});
if (backEndApp.eslint) {
backEndApp.eslint.addRules({ ...eslintGlobalRules });
backEndApp.eslint.addPlugins('prettier');
}
// Defines the Easy Genomics 'front-end' subproject
const frontEndApp = new awscdk.AwsCdkTypeScriptApp({
parent: root,
name: '@easy-genomics/front-end',
outdir: './packages/front-end',
cdkVersion: cdkVersion,
defaultReleaseBranch: defaultReleaseBranch,
docgen: false,
eslint: true,
lambdaAutoDiscover: false,
requireApproval: awscdk.ApprovalLevel.NEVER,
sampleCode: false,
// Copyright & Licensing
authorName: authorName,
authorOrganization: true,
licensed: false, // we apply the Apache 2.0 license later
// Use same settings from root project
packageManager: root.package.packageManager,
projenCommand: root.projenCommand,
minNodeVersion: root.minNodeVersion,
tsconfig: {
...tsConfigOptions,
extends: TypescriptConfigExtends.fromPaths(['./.nuxt/tsconfig.json']),
compilerOptions: {
baseUrl: '.',
lib: ['DOM', 'ES2022'],
sourceMap: true,
types: ['vue'],
verbatimModuleSyntax: false,
paths: {
'@/*': ['../../*'],
'@FE/*': ['src/app/*'],
'@BE/*': ['../packages/back-end/src/app/*'],
'@SharedLib/*': ['../packages/shared-lib/src/app/*'],
'#app': ['node_modules/nuxt/dist/app'], // Nuxt
'#ui/*': ['node_modules/@nuxt/ui/dist/runtime/*'], // NuxtUI
},
},
include: ['.nuxt/**/*.d.ts', 'auto-imports.d.ts', 'components.d.ts', '**/*.ts', '**/*d.ts', '**/*.vue'],
},
deps: [
'@aws-amplify/ui-vue@3.1.30',
'@aws-sdk/client-omics',
'@aws-sdk/client-s3',
'@aws-sdk/s3-request-presigner',
'@aws-sdk/util-format-url',
'@easy-genomics/shared-lib@workspace:*',
'@iconify-json/heroicons',
'@nuxt/ui@2.18.4', // Lock to version 2.18.4 due to input text bug
'@pinia/nuxt',
'@playwright/test',
'@smithy/types',
'@smithy/url-parser',
'@vueuse/core',
'@vueuse/integrations',
'@vueuse/nuxt',
'amazon-cognito-identity-js',
'aws-amplify@5.3.18',
'axios',
'cdk-nag',
'class-variance-authority',
'clsx',
'date-fns',
'dotenv',
'esrun',
'file-saver',
'jwt-decode',
'nuxt',
'pinia',
'pinia-plugin-persistedstate',
'playwright',
'playwright-core',
'playwright-slack-report',
'prettier-plugin-tailwindcss',
'sass',
'tailwind-merge',
'tailwindcss',
'unplugin-vue-components',
'uuid',
'zod',
],
devDeps: [
'@aws-sdk/types',
'@nuxt/types',
'@nuxtjs/eslint-config-typescript',
'@types/node',
'@types/uuid',
'@typescript-eslint/parser',
'eslint-plugin-prettier',
'eslint-plugin-vue',
'kill-port',
'typed-openapi',
'vue-eslint-parser',
],
});
frontEndApp.addScripts({
['cdk-audit']: 'export CDK_AUDIT=true && pnpm dlx projen build',
['build']:
'pnpm run nuxt-reset && pnpm run nuxt-prepare && pnpm dlx projen test && pnpm dlx projen build && pnpm run nuxt-load-settings && pnpm run nuxt-generate',
['deploy']: 'pnpm cdk bootstrap && pnpm dlx projen deploy',
['build-and-deploy']:
'pnpm -w run build-front-end && pnpm cdk bootstrap && pnpm dlx projen deploy --require-approval any-change', // Run root build-front-end script to inc shared-lib
['nuxt-dev']: 'pnpm -w run build-front-end && pnpm kill-port 3000 && nuxt dev',
['nuxt-load-settings']: 'npx esrun nuxt-load-configuration-settings.ts',
['nuxt-generate']: 'nuxt generate',
['nuxt-prepare']: 'nuxt prepare', // Required to create front-end/.nuxt/tsconfig.json
['nuxt-preview']: 'nuxt preview',
['nuxt-postinstall']: 'nuxt prepare',
['test-e2e']:
'pnpm run test-e2e:sys-admin || true && pnpm run test-e2e:org-admin || true && pnpm run test-e2e:lab-manager || true && pnpm run test-e2e:lab-technician || true',
['test-e2e:sys-admin']: 'USER_TYPE=sys-admin npx playwright test --project=sys-admin',
['test-e2e:org-admin']: 'USER_TYPE=org-admin npx playwright test --project=org-admin',
['test-e2e:lab-manager']: 'USER_TYPE=lab-manager npx playwright test --project=lab-manager',
['test-e2e:lab-technician']: 'USER_TYPE=lab-technician npx playwright test --project=lab-technician',
['test-e2e:sys-admin:headed']: 'USER_TYPE=sys-admin npx playwright test --project=sys-admin --ui',
['test-e2e:org-admin:headed']: 'USER_TYPE=org-admin npx playwright test --project=org-admin --ui',
['test-e2e:lab-manager:headed']: 'USER_TYPE=lab-manager npx playwright test --project=lab-manager --ui',
['test-e2e:lab-technician:headed']: 'USER_TYPE=lab-technician npx playwright test --project=lab-technician --ui',
['nuxt-reset']: 'nuxt cleanup',
['nftower-spec-to-zod']: "pnpm typed-openapi ../shared-lib/src/app/types/nf-tower/seqera-api-latest.yml -r 'zod'",
['lint']: "eslint 'src/**/*.{js,ts}' --fix",
});
// Setup Frontend App ESLint configuration
if (frontEndApp.eslint) {
frontEndApp.eslint.addRules({ ...eslintGlobalRules });
frontEndApp.eslint.addExtends(
'@nuxtjs/eslint-config-typescript',
'plugin:prettier/recommended',
'plugin:vue/vue3-recommended',
);
frontEndApp.eslint.addPlugins('eslint-plugin-vue', 'prettier', 'vue');
}
// Apply additional project setup
new PnpmWorkspace(root);
new VscodeSettings(root);
new Nx(root);
new Husky(root);
new GithubActionsCICDRelease(root, { environment: 'quality', pnpmVersion: pnpmVersion, e2e: true });
new GithubActionsCICDRelease(root, { environment: 'quality-uat', pnpmVersion: pnpmVersion, e2e: true });
new GithubActionsCICDRelease(root, {
environment: 'sandbox',
pnpmVersion: pnpmVersion,
onPushBranch: 'infra/*',
e2e: false,
});
new ApacheLicense(root, licenseOptions);
new ApacheLicense(backEndApp, licenseOptions);
new ApacheLicense(frontEndApp, licenseOptions);
new ApacheLicense(sharedLib, licenseOptions);
// Provision templated project folders structure with README.md descriptions.
setupProjectFolders(root);
root.package.addField('packageManager', `pnpm@${pnpmVersion}`);
root.gitignore.addPatterns(
'*.bkp',
'*.dtmp',
'.env',
'.env.*',
'.idea',
'.vscode',
'.DS_Store',
'test-reports',
'.nuxt',
'.output',
'dist',
'config/easy-genomics.yaml',
'packages/back-end/cdk.context.json',
'packages/front-end/test-results',
'packages/front-end/tests/e2e/.auth/*.json',
'packages/front-end/playwright-report',
);
// Synthesize the project
root.synth();