Sync ignore files on format and lint (#646)

Closes #637.

Author: 72636c

.changeset/wet-carrots-argue.md

@@ -0,0 +1,7 @@
+---
+"skuba": minor
+---
+
+format, lint: Synchronise ignore files
+
+`skuba format` and `skuba lint` will now keep `.eslintignore`, `.gitignore` and `.prettierignore` in sync. This automatically applies new exclusions like `.eslintcache` without the need for a manual `skuba configure`.

.gitignore

@@ -1,7 +1,9 @@
 # managed by skuba
+.cdk.staging/
 .idea/
 .serverless/
 .vscode/
+cdk.out/
 node_modules*/
 
 /coverage*/

.prettierignore

@@ -10,6 +10,8 @@ node_modules*/
 /tmp*/
 
 # Gantry resource files support non-standard template syntax
+/.gantry/**/*.yaml
+/.gantry/**/*.yml
 gantry*.yaml
 gantry*.yml
 # end managed by skuba

src/cli/__snapshots__/format.int.test.ts.snap

@@ -62,10 +62,16 @@ Prettier
 Initialising Prettier...
 Detected project root: <random>
 Discovering files...
-Discovered 7 files.
+Discovered 10 files.
 Formatting files...
 .eslintcache
   parser: -
+.eslintignore
+  parser: -
+.gitignore
+  parser: -
+.prettierignore
+  parser: -
 b.md
   parser: markdown
 c.json

src/cli/__snapshots__/lint.int.test.ts.snap

@@ -64,10 +64,16 @@ ESLint   │ ○ d.js
 Prettier │ Initialising Prettier...
 Prettier │ Detected project root: <random>
 Prettier │ Discovering files...
-Prettier │ Discovered 7 files.
+Prettier │ Discovered 10 files.
 Prettier │ Linting files...
 Prettier │ .eslintcache
 Prettier │   parser: -
+Prettier │ .eslintignore
+Prettier │   parser: -
+Prettier │ .gitignore
+Prettier │   parser: -
+Prettier │ .prettierignore
+Prettier │   parser: -
 Prettier │ b.md
 Prettier │   parser: markdown
 Prettier │ c.json

src/cli/configure/refreshIgnoreFiles.ts

@@ -0,0 +1,48 @@
+import path from 'path';
+
+import fs from 'fs-extra';
+
+import { log } from '../../utils/logging';
+import { readBaseTemplateFile } from '../../utils/template';
+
+import { getDestinationManifest } from './analysis/package';
+import { createDestinationFileReader } from './analysis/project';
+import { mergeWithIgnoreFile } from './processing/ignoreFile';
+
+export const refreshIgnoreFiles = async () => {
+  const manifest = await getDestinationManifest();
+
+  const destinationRoot = path.dirname(manifest.path);
+
+  const readDestinationFile = createDestinationFileReader(destinationRoot);
+
+  const refreshIgnoreFile = async (filename: string) => {
+    const [inputFile, templateFile] = await Promise.all([
+      readDestinationFile(filename),
+      readBaseTemplateFile(`_${filename}`),
+    ]);
+
+    const data = inputFile
+      ? mergeWithIgnoreFile(templateFile)(inputFile)
+      : templateFile;
+
+    const filepath = path.join(destinationRoot, filename);
+
+    await fs.promises.writeFile(filepath, data);
+  };
+
+  await Promise.all([
+    refreshIgnoreFile('.eslintignore'),
+    refreshIgnoreFile('.gitignore'),
+    refreshIgnoreFile('.prettierignore'),
+  ]);
+};
+
+export const tryRefreshIgnoreFiles = async () => {
+  try {
+    await refreshIgnoreFiles();
+  } catch (err) {
+    log.warn('Failed to refresh ignore files.');
+    log.warn(err);
+  }
+};

src/cli/format.ts

@@ -5,8 +5,11 @@ import { createLogger, log } from '../utils/logging';
 
 import { runESLint } from './adapter/eslint';
 import { runPrettier } from './adapter/prettier';
+import { tryRefreshIgnoreFiles } from './configure/refreshIgnoreFiles';
 
 export const format = async (args = process.argv) => {
+  await tryRefreshIgnoreFiles();
+
   const debug = hasDebugFlag(args);
 
   log.plain(chalk.magenta('ESLint'));

src/cli/lint/index.ts

@@ -1,4 +1,5 @@
 import { hasDebugFlag, hasSerialFlag } from '../../utils/args';
+import { tryRefreshIgnoreFiles } from '../configure/refreshIgnoreFiles';
 
 import { externalLint } from './external';
 import { internalLint } from './internal';
@@ -9,6 +10,8 @@ export const lint = async (
   tscOutputStream: NodeJS.WritableStream | undefined = undefined,
   workerThreads = true,
 ) => {
+  await tryRefreshIgnoreFiles();
+
   const opts: Input = {
     debug: hasDebugFlag(args),
     serial: hasSerialFlag(args),