diff --git a/.changeset/cyan-knives-drop.md b/.changeset/cyan-knives-drop.md index 3d094b2a5..8659f4392 100644 --- a/.changeset/cyan-knives-drop.md +++ b/.changeset/cyan-knives-drop.md @@ -2,12 +2,6 @@ 'skuba': patch --- -template: Change some lambda worker info logs to debug +template/lambda-sqs-worker: Change some info logs to debug -The "Function succeeded" log message was changed from `info` to `debug` -to reduce the amount of unnecessary logs in production. -The message will still be logged in dev environments but at a `debug` -level. - -The "Function succeeded" log message was retained as it is part of unit-testing -the handler. +The "Function succeeded" log message was changed from `info` to `debug` to reduce the amount of unnecessary logs in production. The message will still be logged in dev environments but at a `debug` level. diff --git a/.changeset/friendly-jokes-travel.md b/.changeset/friendly-jokes-travel.md new file mode 100644 index 000000000..6c65115ab --- /dev/null +++ b/.changeset/friendly-jokes-travel.md @@ -0,0 +1,7 @@ +--- +'skuba': minor +--- + +format, lint: Have Prettier respect `.gitignore` + +This aligns with the behaviour of the [Prettier 3.0 CLI](https://prettier.io/blog/2023/07/05/3.0.0.html#cli). diff --git a/.prettierignore b/.prettierignore index f60135b53..f79f754a9 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,17 +1,4 @@ # managed by skuba -.idea/* -.vscode/* - -.cdk.staging/ -.serverless/ -cdk.out/ -node_modules*/ - -/coverage*/ -/dist*/ -/lib*/ -/tmp*/ - # Gantry resource files support non-standard template syntax /.gantry/**/*.yaml /.gantry/**/*.yml diff --git a/src/cli/__snapshots__/format.int.test.ts.snap b/src/cli/__snapshots__/format.int.test.ts.snap index 8be73a4d6..e7d899274 100644 --- a/src/cli/__snapshots__/format.int.test.ts.snap +++ b/src/cli/__snapshots__/format.int.test.ts.snap @@ -63,10 +63,8 @@ Prettier Initialising Prettier... Detected project root: Discovering files... -Discovered 10 files. +Discovered 9 files. Formatting files... -.eslintcache - parser: - .eslintignore parser: - .gitignore diff --git a/src/cli/__snapshots__/lint.int.test.ts.snap b/src/cli/__snapshots__/lint.int.test.ts.snap index 41c4cf4ad..64ea4b4ec 100644 --- a/src/cli/__snapshots__/lint.int.test.ts.snap +++ b/src/cli/__snapshots__/lint.int.test.ts.snap @@ -78,10 +78,8 @@ ESLint │ ○ d.js Prettier │ Initialising Prettier... Prettier │ Detected project root: Prettier │ Discovering files... -Prettier │ Discovered 10 files. +Prettier │ Discovered 9 files. Prettier │ Linting files... -Prettier │ .eslintcache -Prettier │ parser: - Prettier │ .eslintignore Prettier │ parser: - Prettier │ .gitignore diff --git a/src/cli/adapter/prettier.ts b/src/cli/adapter/prettier.ts index 2a383a764..466fc5691 100644 --- a/src/cli/adapter/prettier.ts +++ b/src/cli/adapter/prettier.ts @@ -169,10 +169,14 @@ export const runPrettier = async ( logger.debug('Discovering files...'); - // Match Prettier's opinion of not respecting `.gitignore`. + // Match Prettier's opinion of respecting `.gitignore`. // This avoids exhibiting different behaviour than a Prettier IDE integration, - // and the headache of conflicting `.gitignore` and `.prettierignore` rules. - const filepaths = await crawlDirectory(directory, '.prettierignore'); + // though it may present headaches if `.gitignore` and `.prettierignore` rules + // conflict. + const filepaths = await crawlDirectory(directory, [ + '.gitignore', + '.prettierignore', + ]); logger.debug(`Discovered ${pluralise(filepaths.length, 'file')}.`); diff --git a/src/cli/configure/analysis/__snapshots__/project.test.ts.snap b/src/cli/configure/analysis/__snapshots__/project.test.ts.snap index 6aa8ba674..fdfc9f29e 100644 --- a/src/cli/configure/analysis/__snapshots__/project.test.ts.snap +++ b/src/cli/configure/analysis/__snapshots__/project.test.ts.snap @@ -85,19 +85,6 @@ yarn-error.log }, ".prettierignore": { "data": "# managed by skuba -.idea/* -.vscode/* - -.cdk.staging/ -.serverless/ -cdk.out/ -node_modules*/ - -/coverage*/ -/dist*/ -/lib*/ -/tmp*/ - # Gantry resource files support non-standard template syntax /.gantry/**/*.yaml /.gantry/**/*.yml diff --git a/src/utils/dir.ts b/src/utils/dir.ts index 33b4c3687..d091cb6a0 100644 --- a/src/utils/dir.ts +++ b/src/utils/dir.ts @@ -36,11 +36,11 @@ export const buildPatternToFilepathMap = ( */ export const crawlDirectory = async ( root: string, - ignoreFilename = '.gitignore', + ignoreFilenames = ['.gitignore'], ) => { - const ignoreFileFilter = await createInclusionFilter([ - path.join(root, ignoreFilename), - ]); + const ignoreFileFilter = await createInclusionFilter( + ignoreFilenames.map((ignoreFilename) => path.join(root, ignoreFilename)), + ); const output = await new FDir() .crawlWithOptions(root, { diff --git a/template/base/_.prettierignore b/template/base/_.prettierignore index 2ec7efc66..58c1da8f1 100644 --- a/template/base/_.prettierignore +++ b/template/base/_.prettierignore @@ -1,17 +1,4 @@ # managed by skuba -.idea/* -.vscode/* - -.cdk.staging/ -.serverless/ -cdk.out/ -node_modules*/ - -/coverage*/ -/dist*/ -/lib*/ -/tmp*/ - # Gantry resource files support non-standard template syntax /.gantry/**/*.yaml /.gantry/**/*.yml