Merge pull request #64 from nodejs-monorepo-templates/sane-fmt

Replace StandardJS with sane-fmt

Author: KSXGitHub

.github/workflows/nodejs.yml

@@ -13,6 +13,7 @@ on:
       - '!*.draft'
       - '!draft.*'
   pull_request: {}
+  workflow_dispatch: {}
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -40,6 +41,9 @@ jobs:
           - id: 5
             node: 14.x
             pnpm: --frozen-lockfile
+          - id: 6
+            node: 14.x
+            cmd: pnpm run sane-fmt -- --log-format=github-actions --details=diff
     steps:
       - uses: actions/checkout@v1
       - name: Use Node.js ${{ matrix.vars.node }}

package.json

@@ -13,7 +13,6 @@
   "devDependencies": {
     "standard": "^14.3.4",
     "tslint": "^6.1.2",
-    "tslint-config-standard": "^9.0.0",
     "typescript": "^3.9.7",
     "toolcheck": "^0.1.4",
     "tslib": "^2.0.0",
@@ -31,8 +30,8 @@
     "execute": "execute",
     "glob": "execute glob",
     "workspace": "execute workspace",
-    "standardjs": "execute runStandardJS",
-    "standardjs:fix": "execute runStandardJS --fix",
+    "sane-fmt": "execute runSaneFmt",
+    "sane-fmt:fix": "execute runSaneFmtFix",
     "tslint": "execute runTSLint",
     "tslint:fix": "execute runTSLint --fix",
     "test": "execute test",

pnpm-lock.yaml

@@ -4,17 +4,18 @@ import { spawnSync } from 'child_process'
 import semver from 'semver'
 import { project } from '@tools/places'
 
-const mkfn = (file: string, pkgmgr: string) => () => {
-  if (existsSync(path.resolve(project, file))) {
-    console.info([
-      `This project does not use ${pkgmgr} to install/link its dependencies.`,
-      'Please use pnpm instead.',
-      'More info at: https://pnpm.js.org/'
-    ].join('\n'))
-
-    throw new Error(`File ${file} detected.`)
+const mkfn = (file: string, pkgmgr: string) =>
+  () => {
+    if (existsSync(path.resolve(project, file))) {
+      console.info([
+        `This project does not use ${pkgmgr} to install/link its dependencies.`,
+        'Please use pnpm instead.',
+        'More info at: https://pnpm.js.org/',
+      ].join('\n'))
+
+      throw new Error(`File ${file} detected.`)
+    }
   }
-}
 
 it('Not using npm', mkfn('package-lock.json', 'npm'))
 it('Not using yarn', mkfn('yarn.lock', 'yarn'))

test/package-manager/index.test.ts

@@ -0,0 +1,22 @@
+'use strict'
+const cmd = require('@tools/test-spawn')
+const { command, listTargets } = require('@tools/sane-fmt')
+
+it('Code Style: sane-fmt', async () => {
+  const argvPrefix = [
+    command,
+    '--hide-passed',
+  ]
+
+  const argvSuffix = [
+    '--',
+    ...await listTargets(),
+  ]
+
+  cmd({
+    argvPrefix,
+    argvSuffix,
+    defaultExecutable: require('process').execPath,
+    envMiddleName: 'SANE_FMT',
+  })
+})

test/sane-fmt/index.test.js

@@ -0,0 +1,7 @@
+{
+  "private": true,
+  "dependencies": {
+    "@tools/test-spawn": "file:../../tools/test-spawn",
+    "@tools/sane-fmt": "file:../../tools/sane-fmt"
+  }
+}

test/sane-fmt/package.json

@@ -5,9 +5,10 @@ const { lookpath } = require('lookpath')
 const cmd = require('@tools/test-spawn')
 const places = require('@tools/places')
 
-const listShellFiles = async () => (await fs.readdir(path.join(places.project, 'ci')))
-  .filter(name => name.endsWith('.sh') || name.endsWith('.bash'))
-  .map(name => path.join('ci', name))
+const listShellFiles = async () =>
+  (await fs.readdir(path.join(places.project, 'ci')))
+    .filter(name => name.endsWith('.sh') || name.endsWith('.bash'))
+    .map(name => path.join('ci', name))
 
 it('ShellCheck', async () => {
   const shellcheck = await lookpath('shellcheck')
@@ -19,6 +20,6 @@ it('ShellCheck', async () => {
 
   cmd({
     defaultExecutable: shellcheck,
-    argvSuffix: await listShellFiles()
+    argvSuffix: await listShellFiles(),
   })
 })