mikoshi-construct 0.1.3 → 0.2.0

package/templates/presets/node-frontend/baseline/scripts/tests/lint/syntax-policy.test.ts

@@ -0,0 +1,78 @@
+import { ESLint } from 'eslint'
+import { describe, expect, it } from 'vitest'
+import { REPO_ROOT } from '../../composition/files.js'
+
+const SAMPLES = {
+  plainModule: 'export function open(element: HTMLElement): void {\n  element.dataset.state = \'open\'\n}\n',
+  classListCall: 'export function open(element: HTMLElement): void {\n  element.classList.add(\'is-open\')\n}\n',
+  classListComputed: 'export function open(element: HTMLElement): void {\n  element.classList[\'add\'](\'is-open\')\n}\n',
+  classListOnComputedElement: 'export function open(element: HTMLElement): void {\n  element[\'classList\'].add(\'is-open\')\n}\n',
+  classListBound: 'export function open(element: HTMLElement): void {\n  const classes = element.classList\n  classes.add(\'is-open\')\n}\n',
+  inlineStyleWrite: 'export function open(element: HTMLElement): void {\n  element.style.display = \'block\'\n}\n',
+  inlineStyleWriteComputed: 'export function open(element: HTMLElement): void {\n  element[\'style\'].display = \'block\'\n}\n',
+  inlineStyleProperty: 'export function open(element: HTMLElement): void {\n  element.style.setProperty(\'--open\', \'1\')\n}\n',
+  inlineStylePropertyComputed: 'export function open(element: HTMLElement): void {\n  element.style[\'setProperty\'](\'--open\', \'1\')\n}\n',
+  inlineStyleBound: 'export function open(element: HTMLElement): void {\n  const style = element.style\n  style.display = \'block\'\n}\n',
+} as const
+
+type SampleName = keyof typeof SAMPLES
+
+const CLASS_LIST_FORMS: SampleName[] = ['classListCall', 'classListComputed', 'classListOnComputedElement', 'classListBound']
+const INLINE_STYLE_FORMS: SampleName[] = ['inlineStyleWrite', 'inlineStyleWriteComputed', 'inlineStyleProperty', 'inlineStylePropertyComputed', 'inlineStyleBound']
+
+const ROLES: Array<{ role: string, file: string, reported: SampleName[], exempt: SampleName[] }> = [
+  {
+    role: 'an application module',
+    file: 'src/app.ts',
+    reported: [...CLASS_LIST_FORMS, ...INLINE_STYLE_FORMS],
+    exempt: [],
+  },
+  {
+    role: 'the entry point',
+    file: 'src/main.ts',
+    reported: [...CLASS_LIST_FORMS, ...INLINE_STYLE_FORMS],
+    exempt: [],
+  },
+  {
+    role: 'a test',
+    file: 'tests/app.test.ts',
+    reported: [],
+    exempt: [...CLASS_LIST_FORMS, ...INLINE_STYLE_FORMS],
+  },
+  {
+    role: 'a repository script',
+    file: 'scripts/composition/check.ts',
+    reported: [],
+    exempt: [...CLASS_LIST_FORMS, ...INLINE_STYLE_FORMS],
+  },
+]
+
+const eslint = new ESLint({
+  cwd: REPO_ROOT,
+  ruleFilter: ({ ruleId }) => ruleId === 'no-restricted-syntax',
+  overrideConfig: { languageOptions: { parserOptions: { projectService: false } } },
+})
+
+async function restrictionReports(file: string, sample: SampleName): Promise<string[]> {
+  const [result] = await eslint.lintText(SAMPLES[sample], { filePath: file })
+  const fatal = result.messages.find(message => message.fatal)
+  if (fatal)
+    throw new Error(`${file} (${sample}): ${fatal.message}`)
+  return result.messages
+    .filter(message => message.ruleId === 'no-restricted-syntax')
+    .map(message => message.message)
+}
+
+describe('styling policy by file role', () => {
+  for (const { role, file, reported, exempt } of ROLES) {
+    it(`reports every restricted form in ${role}`, async () => {
+      for (const sample of reported)
+        expect(await restrictionReports(file, sample), sample).not.toEqual([])
+    })
+
+    it(`reports nothing ${role} may legitimately write`, async () => {
+      for (const sample of ['plainModule' as SampleName, ...exempt])
+        expect(await restrictionReports(file, sample), sample).toEqual([])
+    })
+  }
+})

package/templates/presets/monorepo/sample/scripts/tests/lint/syntax-policy.test.ts.eta

@@ -1,36 +0,0 @@
-import { ESLint } from 'eslint'
-import { describe, expect, it } from 'vitest'
-import { REPO_ROOT } from '../../composition/files.js'
-
-const PROCESS = 'MemberExpression[object.name="process"]'
-const PROCESS_ENV = 'MemberExpression[object.name="process"][property.name="env"]'
-const RAW_REQUEST_DATA = 'MemberExpression[object.name="req"][property.name=/^(body|query|params)$/]'
-const RAW_SQL = 'CallExpression[callee.object.name="sql"][callee.property.name="raw"]'
-const SHARED_IMPORT = ':matches(ImportDeclaration, ExportNamedDeclaration, ExportAllDeclaration)[source.value=/^{{scope}}\\/shared(\\/|$)/]'
-
-const eslint = new ESLint({ cwd: REPO_ROOT })
-
-async function restrictedSelectors(file: string): Promise<string[]> {
-  const config = await eslint.calculateConfigForFile(file)
-  const [, ...restrictions] = config.rules['no-restricted-syntax'] as [unknown, ...Array<{ selector: string }>]
-  return restrictions.map(restriction => restriction.selector).sort()
-}
-
-const ROLES: Array<{ role: string, file: string, selectors: string[] }> = [
-  { role: 'a service', file: 'apps/api/src/things/things.service.ts', selectors: [PROCESS, RAW_REQUEST_DATA, RAW_SQL, SHARED_IMPORT] },
-  { role: 'a controller', file: 'apps/api/src/things/things.controller.ts', selectors: [PROCESS, RAW_SQL, SHARED_IMPORT] },
-  { role: 'a middleware', file: 'apps/api/src/http/error-handler.middleware.ts', selectors: [PROCESS, RAW_SQL, SHARED_IMPORT] },
-  { role: 'the contract types gateway', file: 'apps/api/src/contracts/types.ts', selectors: [PROCESS, RAW_REQUEST_DATA, RAW_SQL] },
-  { role: 'the app config', file: 'apps/api/src/config.ts', selectors: [RAW_SQL, SHARED_IMPORT] },
-  { role: 'the process entry', file: 'apps/api/src/server.ts', selectors: [RAW_SQL, SHARED_IMPORT] },
-  { role: 'a package module', file: 'packages/shared/src/index.ts', selectors: [PROCESS_ENV, RAW_SQL] },
-  { role: 'a package config', file: 'packages/shared/src/shared.config.ts', selectors: [RAW_SQL] },
-]
-
-describe('syntax policy by file role', () => {
-  for (const { role, file, selectors } of ROLES) {
-    it(`keeps every restriction that applies to ${role}`, async () => {
-      expect(await restrictedSelectors(file)).toEqual([...selectors].sort())
-    })
-  }
-})

package/templates/presets/node-backend/sample/scripts/tests/lint/syntax-policy.test.ts

@@ -1,31 +0,0 @@
-import { ESLint } from 'eslint'
-import { describe, expect, it } from 'vitest'
-import { REPO_ROOT } from '../../composition/files.js'
-
-const PROCESS = 'MemberExpression[object.name="process"]'
-const RAW_REQUEST_DATA = 'MemberExpression[object.name="req"][property.name=/^(body|query|params)$/]'
-const RAW_SQL = 'CallExpression[callee.object.name="sql"][callee.property.name="raw"]'
-
-const eslint = new ESLint({ cwd: REPO_ROOT })
-
-async function restrictedSelectors(file: string): Promise<string[]> {
-  const config = await eslint.calculateConfigForFile(file)
-  const [, ...restrictions] = config.rules['no-restricted-syntax'] as [unknown, ...Array<{ selector: string }>]
-  return restrictions.map(restriction => restriction.selector).sort()
-}
-
-const ROLES: Array<{ role: string, file: string, selectors: string[] }> = [
-  { role: 'a service', file: 'src/things/things.service.ts', selectors: [PROCESS, RAW_REQUEST_DATA, RAW_SQL] },
-  { role: 'a controller', file: 'src/things/things.controller.ts', selectors: [PROCESS, RAW_SQL] },
-  { role: 'a middleware', file: 'src/http/error-handler.middleware.ts', selectors: [PROCESS, RAW_SQL] },
-  { role: 'the app config', file: 'src/config.ts', selectors: [RAW_SQL] },
-  { role: 'the process entry', file: 'src/server.ts', selectors: [RAW_SQL] },
-]
-
-describe('syntax policy by file role', () => {
-  for (const { role, file, selectors } of ROLES) {
-    it(`keeps every restriction that applies to ${role}`, async () => {
-      expect(await restrictedSelectors(file)).toEqual([...selectors].sort())
-    })
-  }
-})