Merge pull request #44 from ember-cli/setup-prettier

Add prettier so our PRs don't have accidental changes

Author: ef4

.github/workflows/ci.yml

@@ -13,6 +13,20 @@ env:
   CI: true
 
 jobs:
+  lint:
+    name: Lint
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - uses: actions/setup-node@v4
+        with:
+          cache: pnpm
+      - name: Install Dependencies
+        run: pnpm install --frozen-lockfile
+      - run: pnpm lint
+
   tests:
     name: Tests
     timeout-minutes: 5

.prettierignore

@@ -0,0 +1,8 @@
+*.yaml
+*.yml
+*.md
+files/
+tests/fixtures/
+
+node_modules/
+

.prettierrc.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = {
+  printWidth: 100,
+  overrides: [
+    {
+      files: '*.{js,ts,mjs,mts,cjs,cts}',
+      options: {
+        singleQuote: true,
+      },
+    },
+  ],
+};

index.js

@@ -49,7 +49,7 @@ module.exports = {
     if (options.ciProvider !== 'github') {
       files = files.filter((file) => file.indexOf('.github') < 0);
     }
-    
+
     if (!options.typescript) {
       let ignoredFiles = ['tsconfig.json'];
 

package.json

@@ -11,9 +11,12 @@
   },
   "license": "MIT",
   "author": "",
-  "scripts": {},
-  "dependencies": {},
+  "scripts": {
+    "lint": "prettier --check .",
+    "format": "prettier --write ."
+  },
   "devDependencies": {
+    "prettier": "^3.5.3",
     "release-plan": "^0.16.0"
   },
   "packageManager": "pnpm@10.6.5"

pnpm-lock.yaml

@@ -27,7 +27,7 @@ export async function readFixture(
      * Which fixture set to use
      */
     scenario?: string;
-  }
+  },
 ) {
   let scenario = options?.scenario ?? 'default';
   let fixtureFilePath = path.isAbsolute(file) ? file : path.join(fixturesPath, scenario, file);
@@ -36,7 +36,7 @@ export async function readFixture(
 
   assert(
     exists,
-    `Fixture file '${file}' does not exist. To make this work, place a new file '${file}' in the 'tests/fixtures/${scenario}' directory. Checked the absolute path: '${fixtureFilePath}'.`
+    `Fixture file '${file}' does not exist. To make this work, place a new file '${file}' in the 'tests/fixtures/${scenario}' directory. Checked the absolute path: '${fixtureFilePath}'.`,
   );
 
   let contents = await fs.readFile(fixtureFilePath);
@@ -48,15 +48,15 @@ export async function writeFixture(
   /**
    * Which file within in the fixture-set / scenario to read
    */
-  file: string, 
+  file: string,
   contents: string,
-  options?: { 
+  options?: {
     /**
      * Which fixture set to use
      */
-  scenario?: string }) {
-
-
+    scenario?: string;
+  },
+) {
   let scenario = options?.scenario ?? 'default';
   let fixtureFilePath = path.isAbsolute(file) ? file : path.join(fixturesPath, scenario, file);
 
@@ -85,7 +85,7 @@ export async function copyFixture(
      * The working directory to use for the relative paths. Defaults to process.cwd() (node default)
      */
     cwd?: string;
-  }
+  },
 ) {
   let scenario = options?.scenario ?? 'default';
   let fixtureFile = options?.file ?? newFile;
@@ -99,7 +99,7 @@ export async function copyFixture(
 
   assert(
     exists,
-    `Fixture path '${fixtureFile}' does not exist. To make this work, place a new file/folder '${fixtureFile}' in the 'tests/fixtures/${scenario}' directory. Checked the absolute path: '${fullFixturePath}'.`
+    `Fixture path '${fixtureFile}' does not exist. To make this work, place a new file/folder '${fixtureFile}' in the 'tests/fixtures/${scenario}' directory. Checked the absolute path: '${fullFixturePath}'.`,
   );
 
   if (await isDirectory(fullFixturePath)) {

tests/helpers/fixtures.ts

@@ -28,11 +28,7 @@ export class AddonHelper {
   #args: string[];
   #fixtures: AddonFixtureHelper | undefined;
 
-  constructor(options: {
-    args?: string[];
-    scenario?: string;
-    packageManager: 'pnpm' | 'npm';
-  }) {
+  constructor(options: { args?: string[]; scenario?: string; packageManager: 'pnpm' | 'npm' }) {
     this.#args = options.args || [];
     this.#scenario = options.scenario || 'default';
     this.#packageManager = options.packageManager;
@@ -85,7 +81,7 @@ export class AddonHelper {
 
     assert(
       this.#tmpDir,
-      "Cannot clean without a tmpDir. Was the Addon Helper's `setup` method called to generate the addon?"
+      "Cannot clean without a tmpDir. Was the Addon Helper's `setup` method called to generate the addon?",
     );
 
     await fs.rm(this.#tmpDir, { recursive: true, force: true });

tests/helpers/meta-helpers.ts

@@ -32,19 +32,20 @@ describe(`declarations-configuration`, () => {
     it('there are no top-level files, only nested in folders', async () => {
       await fse.rm(path.join(helper.projectRoot, 'src'), { recursive: true });
       await fse.mkdirp(path.join(helper.projectRoot, 'src/components'));
-      await fs.writeFile(path.join(helper.projectRoot, 'src/components/example.ts'), '/* empty file */');
+      await fs.writeFile(
+        path.join(helper.projectRoot, 'src/components/example.ts'),
+        '/* empty file */',
+      );
 
       let buildResult = await helper.build();
 
       expect(buildResult.exitCode).toEqual(0);
 
-      expect(await dirContents(declarationsDir)).to.deep.equal([
-        'components',
-      ]);
+      expect(await dirContents(declarationsDir)).to.deep.equal(['components']);
 
       expect(await dirContents(path.join(declarationsDir, 'components'))).to.deep.equal([
         'example.d.ts',
-        'example.d.ts.map'
+        'example.d.ts.map',
       ]);
     });
   });

tests/rollup-build-tests/declarations.test.ts

@@ -3,7 +3,7 @@ import path, { join } from 'node:path';
 import tmp from 'tmp-promise';
 let localEmberCli = require.resolve('ember-cli/bin/ember');
 import { beforeAll, describe, expect, it } from 'vitest';
-import {execa } from 'execa';
+import { execa } from 'execa';
 import fixturify from 'fixturify';
 
 const blueprintPath = path.join(__dirname, '../..');
@@ -13,7 +13,7 @@ import {
   assertGeneratedCorrectly,
   dirContents,
   matchesFixture,
-  SUPPORTED_PACKAGE_MANAGERS
+  SUPPORTED_PACKAGE_MANAGERS,
 } from '../helpers.js';
 import { existsSync } from 'node:fs';
 
@@ -22,12 +22,14 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
     let tmpDir: string;
     let addonDir: string;
     let addonName = 'my-addon';
-    
+
     beforeAll(async () => {
       tmpDir = (await tmp.dir()).path;
-      addonDir = join(tmpDir, addonName)
-      await execa({cwd: tmpDir})`${localEmberCli} addon ${addonName} -b ${blueprintPath} --skip-npm --skip-git --prefer-local true --${packageManager}`;
-      await execa({cwd: addonDir})`${packageManager} install`
+      addonDir = join(tmpDir, addonName);
+      await execa({
+        cwd: tmpDir,
+      })`${localEmberCli} addon ${addonName} -b ${blueprintPath} --skip-npm --skip-git --prefer-local true --${packageManager}`;
+      await execa({ cwd: addonDir })`${packageManager} install`;
     });
 
     it('is using the correct packager', async () => {
@@ -59,7 +61,7 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
           });
           await matchesFixture('CONTRIBUTING.md', {
             cwd: addonDir,
-            scenario: 'pnpm' 
+            scenario: 'pnpm',
           });
           await matchesFixture('.npmrc', {
             cwd: addonDir,
@@ -87,7 +89,7 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
     // Tests are additive, so when running them in order, we want to check linting
     // before we add files from fixtures
     it('lints with no fixtures all pass', async () => {
-      let { exitCode } = await execa({cwd: addonDir})`pnpm lint`;
+      let { exitCode } = await execa({ cwd: addonDir })`pnpm lint`;
 
       expect(exitCode).toEqual(0);
     });
@@ -103,31 +105,32 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
       // It's important to keep this along with the tests,
       // so that we can have confidence that the lints aren't destructively changing
       // the files in a way that would break consumers
-      let { exitCode } = await execa({cwd: addonDir})`${packageManager} run lint:fix`;
+      let { exitCode } = await execa({ cwd: addonDir })`${packageManager} run lint:fix`;
 
       expect(exitCode).toEqual(0);
 
-      let buildResult = await execa({cwd: addonDir})`${packageManager} run build`;
+      let buildResult = await execa({ cwd: addonDir })`${packageManager} run build`;
 
       expect(buildResult.exitCode).toEqual(0);
 
       let contents = await dirContents(join(addonDir, 'dist'));
 
       expect(contents).to.deep.equal(['_app_', 'components', 'index.js', 'index.js.map']);
 
-      let testResult = await await execa({cwd: addonDir})`${packageManager} run test`;
+      let testResult = await await execa({ cwd: addonDir })`${packageManager} run test`;
 
       expect(testResult.exitCode).toEqual(0);
 
-      expect(testResult.stdout).includes(`# tests 2
+      expect(testResult.stdout).includes(
+        `# tests 2
 # pass  2
 # skip  0
 # todo  0
 # fail  0
 
-# ok`, testResult.stdout);
-      
-      
+# ok`,
+        testResult.stdout,
+      );
     });
   });
 }