@langri-sha/projen-lint-synthesized 0.1.0

package/CHANGELOG.json

@@ -0,0 +1,34 @@
+{
+  "name": "@langri-sha/projen-lint-synthesized",
+  "entries": [
+    {
+      "date": "Tue, 30 Apr 2024 23:02:26 GMT",
+      "version": "0.1.0",
+      "tag": "@langri-sha/projen-lint-synthesized_v0.1.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-lint-synthesized",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "feat(projen-lint-synthesized): Configure ESM support"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-lint-synthesized",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "Add initial support for linting synthesized files"
+          }
+        ],
+        "patch": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-lint-synthesized",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "fix(lint-synthesized): Add missing spaces between filenames"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log - @langri-sha/projen-lint-synthesized
+
+This log was last generated on Tue, 30 Apr 2024 23:02:26 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.1.0
+
+Tue, 30 Apr 2024 23:02:26 GMT
+
+### Minor changes
+
+- feat(projen-lint-synthesized): Configure ESM support (filip.dupanovic@gmail.com)
+- Add initial support for linting synthesized files (filip.dupanovic@gmail.com)
+
+### Patches
+
+- fix(lint-synthesized): Add missing spaces between filenames (filip.dupanovic@gmail.com)

package/license

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 Filip Dupanović <filip.dupanovic@gmail.com> (https://langri-sha.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@langri-sha/projen-lint-synthesized",
+  "version": "0.1.0",
+  "license": "MIT",
+  "type": "module",
+  "main": "src/index.ts",
+  "dependencies": {
+    "debug": "4.3.4",
+    "minimatch": "9.0.4"
+  },
+  "devDependencies": {
+    "@langri-sha/jest-test": "0.2.0",
+    "@langri-sha/tsconfig": "0.2.0",
+    "@types/debug": "4.1.12",
+    "execa": "8.0.1",
+    "prettier": "3.2.5",
+    "projen": "0.81.1"
+  },
+  "peerDependencies": {
+    "projen": "^0.81.1",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme

@@ -0,0 +1,9 @@
+# @langri-sha/projen-lint-synthesized
+
+A [projen] component that you can add to your project to configure linters for
+synthesized files.
+
+This is especially uself for workspaces that are migrating to projen, or rely on
+existing lint configurations.
+
+[projen]: https://projen.io/

package/src/__snapshots__/index.test.ts.snap

@@ -0,0 +1,23 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`defaults 1`] = `
+{
+  ".gitignore": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+node_modules/
+!/.gitattributes
+!/.projen/tasks.json
+!/.projen/deps.json
+!/.projen/files.json
+",
+  ".projen/files.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "files": [
+      ".gitattributes",
+      ".gitignore",
+      ".projen/deps.json",
+      ".projen/files.json",
+      ".projen/tasks.json",
+    ],
+  },
+}
+`;

package/src/index.test.ts

@@ -0,0 +1,80 @@
+import { directorySnapshot } from 'projen/lib/util/synth'
+import { expect, tempy, test } from '@langri-sha/jest-test'
+
+import { promises as fs } from 'node:fs'
+import path from 'node:path'
+
+import { Project, TextFile } from 'projen'
+import { LintSynthesized, type LintSynthesizedOptions } from './index'
+
+const setup = (options?: LintSynthesizedOptions) => {
+  const outdir = tempy.directory()
+
+  const project = new Project({
+    name: 'test-project',
+    outdir,
+  })
+
+  project.removeTask('build')
+  project.removeTask('compile')
+  project.removeTask('eject')
+  project.removeTask('default')
+  project.removeTask('package')
+  project.removeTask('post-compile')
+  project.removeTask('pre-compile')
+  project.removeTask('test')
+
+  new LintSynthesized(project, options)
+
+  return { project }
+}
+
+test('defaults', () => {
+  const { project } = setup()
+
+  project.synth()
+  expect(directorySnapshot(project.outdir)).toMatchSnapshot()
+})
+
+test('lints synthesized files', async () => {
+  const { project } = setup({
+    '*': 'prettier --ignore-unknown --write',
+  })
+
+  let file, contents
+
+  file = new TextFile(project, 'test1.js')
+  file.addLine(`module.exports = ${JSON.stringify({ foo: 'bar' })}`)
+
+  file = new TextFile(project, 'test2.js')
+  file.addLine(`module.exports = ${JSON.stringify({ foo: 'bar' })}`)
+
+  project.synth()
+
+  file = await fs.readFile(path.join(project.outdir, 'test1.js'))
+  contents = file.toString('utf8')
+
+  expect(contents).toEqual(`module.exports = { foo: "bar" };\n`)
+
+  file = await fs.readFile(path.join(project.outdir, 'test2.js'))
+  contents = file.toString('utf8')
+
+  expect(contents).toEqual(`module.exports = { foo: "bar" };\n`)
+})
+
+test('preserves file modes', async () => {
+  const { project } = setup({
+    '*': 'prettier --ignore-unknown',
+  })
+
+  new TextFile(project, 'test.sh', {
+    executable: true,
+    readonly: true,
+  })
+
+  project.synth()
+
+  await expect(
+    fs.stat(path.join(project.outdir, 'test.sh')),
+  ).resolves.toHaveProperty('mode', 33_124)
+})

package/src/index.ts

@@ -0,0 +1,102 @@
+import { Component } from 'projen'
+import createDebug from 'debug'
+
+import * as fs from 'node:fs'
+
+import { execaSync } from 'execa'
+import { minimatch } from 'minimatch'
+
+const debug = createDebug('projen-lint-synthesized')
+
+export interface LintSynthesizedOptions {
+  [pattern: string]: string | ((files: string[]) => string)
+}
+
+/**
+ * A component that lints synthesized files.
+ */
+export class LintSynthesized extends Component {
+  #options?: LintSynthesizedOptions
+
+  constructor(
+    scope: ConstructorParameters<typeof Component>[0],
+    options?: LintSynthesizedOptions,
+  ) {
+    super(scope, 'lint-synthesized')
+
+    this.#options = options
+
+    debug('Initialized')
+  }
+
+  override postSynthesize(): void {
+    super.postSynthesize()
+
+    debug('Commencing lints on synthesized files')
+
+    const fileInfo = Object.fromEntries(
+      this.project.files
+        .filter((file) => fs.existsSync(file.absolutePath))
+        .map((file) => [
+          file.path,
+          {
+            file,
+            absolutePath: file.absolutePath,
+            mode: fs.statSync(file.absolutePath).mode,
+          },
+        ]),
+    )
+    const paths = Object.keys(fileInfo)
+
+    debug(`Found ${paths.length} synthesized files`)
+
+    const tasks = Object.entries(this.#options || {})
+      .map(([pattern, command]) => ({
+        pattern,
+        command,
+        files: minimatch.match(paths, pattern),
+      }))
+      .filter(({ files }) => files.length)
+
+    for (const { files } of tasks) {
+      for (const file of files) {
+        const { absolutePath } = fileInfo[file]
+
+        fs.chmodSync(absolutePath, 0o755)
+      }
+    }
+
+    for (const { pattern, command, files } of tasks) {
+      debug(`Running command ${files.length} files matching pattern ${pattern}`)
+
+      try {
+        this.#run(files, command)
+      } catch {
+        // Let `execa` log errors.
+      }
+    }
+
+    for (const { files } of tasks) {
+      for (const file of files) {
+        const { absolutePath, mode } = fileInfo[file]
+
+        fs.chmodSync(absolutePath, mode)
+      }
+    }
+  }
+
+  #run(files: string[], command: string | ((files: string[]) => string)) {
+    const task =
+      typeof command === 'string'
+        ? `${command} ${files.join(' ')}`
+        : command(files)
+
+    debug(`Running command ${task}`)
+
+    execaSync(task, {
+      shell: true,
+      stdio: 'inherit',
+      cwd: this.project.outdir,
+    })
+  }
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "@langri-sha/tsconfig/project.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "outDir": ".tsbuild"
+  },
+  "references": [{ "path": "../jest-test" }, { "path": "../tsconfig" }]
+}