feat(node): toggle

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

.eslintrc.cjs

@@ -11,7 +11,15 @@
 const config = {
   root: true,
   extends: ['./.eslintrc.base.cjs'],
-  overrides: [...require('./.eslintrc.base.cjs').overrides]
+  overrides: [
+    ...require('./.eslintrc.base.cjs').overrides,
+    {
+      files: ['./src/toggle.ts'],
+      rules: {
+        'unicorn/prefer-json-parse-buffer': 0
+      }
+    }
+  ]
 }
 
 module.exports = config

__mocks__/.gitkeep

@@ -0,0 +1,37 @@
+/**
+ * @file Mocks - fs
+ * @module mocks/fs
+ * @see https://nodejs.org/docs/latest-v16.x/api/fs.html
+ */
+
+import volume from '#fixtures/volume'
+import type { TDataOut } from 'memfs/lib/encoding'
+import type { IWriteFileOptions, TData, TFileId } from 'memfs/lib/volume'
+
+/**
+ * Synchronously returns the contents of `path`.
+ *
+ * @see https://nodejs.org/docs/latest-v16.x/api/fs.html#fsreadfilesyncpath-options
+ *
+ * @param {TFileId} path - Filename or file descriptor
+ * @param {IWriteFileOptions | string} [options] - Read file options
+ * @return {TDataOut} File content
+ */
+export const readFileSync = vi.fn(volume.readFileSync.bind(volume))
+
+/**
+ * Synchronously writes `data` to `file`, replacing `file` if it already exists.
+ *
+ * @see https://nodejs.org/docs/latest-v16.x/api/fs.html#fswritefilesyncfile-data-options
+ *
+ * @param {TFileId} file - Filename or file descriptor
+ * @param {TData} data - File content
+ * @param {IWriteFileOptions} [options] - Write file options
+ * @return {Promise<void>} Nothing when complete
+ */
+export const writeFileSync = vi.fn(volume.writeFileSync.bind(volume))
+
+export default {
+  readFileSync,
+  writeFileSync
+}

__mocks__/fs.ts

@@ -143,6 +143,7 @@
     "trash-cli": "5.0.0",
     "ts-dedent": "2.2.0",
     "ts-node": "10.9.1",
+    "type-fest": "3.0.0",
     "typescript": "4.8.4",
     "version-bump-prompt": "6.1.0",
     "vite": "3.1.4",

package.json

@@ -0,0 +1,85 @@
+/**
+ * @file Functional Tests - toggle
+ * @module toggle-pkg-type/tests/toggle/functional
+ */
+
+import vfs from '#fixtures/volume'
+import type { PackageJson } from 'type-fest'
+import testSubject from '../toggle'
+
+vi.mock('node:fs')
+
+describe('functional:toggle', () => {
+  afterEach(() => {
+    vfs.reset()
+  })
+
+  it('should do nothing if package type is undefined', () => {
+    // Arrange
+    const pkg: PackageJson = { name: 'foo', version: '1.0.0' }
+    const pkgstring: string = JSON.stringify(pkg, null, 2) + '\n'
+    vfs.writeFileSync('./package.json', pkgstring)
+
+    // Act
+    testSubject()
+
+    // Expect
+    expect(vfs.readFileSync('./package.json', 'utf8')).to.equal(pkgstring)
+  })
+
+  describe('disable', () => {
+    const pkg: PackageJson = { type: 'module' }
+
+    beforeEach(() => {
+      vfs.writeFileSync('./package.json', JSON.stringify(pkg, null, 2) + '\n')
+    })
+
+    it('should disable package type with "off"', () => {
+      // Act
+      testSubject('off')
+
+      // Expect
+      expect(JSON.parse(vfs.readFileSync('./package.json', 'utf8') as string))
+        .to.have.property('#type')
+        .that.equals(pkg.type)
+    })
+
+    it('should disable package type without command', () => {
+      // Act
+      testSubject()
+
+      // Expect
+      expect(JSON.parse(vfs.readFileSync('./package.json', 'utf8') as string))
+        .to.have.property('#type')
+        .that.equals(pkg.type)
+    })
+  })
+
+  describe('enable', () => {
+    const pkg: PackageJson = { '#type': 'module' }
+
+    beforeEach(() => {
+      vfs.writeFileSync('./package.json', JSON.stringify(pkg, null, 2) + '\n')
+    })
+
+    it('should enable package type with "on"', () => {
+      // Act
+      testSubject('on')
+
+      // Expect
+      expect(JSON.parse(vfs.readFileSync('./package.json', 'utf8') as string))
+        .to.have.property('type')
+        .that.equals(pkg['#type'])
+    })
+
+    it('should enable package type without command', () => {
+      // Act
+      testSubject()
+
+      // Expect
+      expect(JSON.parse(vfs.readFileSync('./package.json', 'utf8') as string))
+        .to.have.property('type')
+        .that.equals(pkg['#type'])
+    })
+  })
+})

src/__tests__/toggle.functional.spec.ts

@@ -3,4 +3,64 @@
  * @module toggle-pkg-type/toggle
  */
 
-export default {}
+import fs from 'node:fs'
+import path from 'node:path'
+import type { PackageJson } from 'type-fest'
+
+/**
+ * Enables or disables [`type`][1] in `package.json`.
+ *
+ * [1]: https://nodejs.org/api/packages.html#type
+ *
+ * @example
+ *  toggle()
+ * @example
+ *  toggle('off')
+ * @example
+ *  toggle('on')
+ *
+ * @param {'off' | 'on'} [command] - Toggle command
+ * @return {void} Nothing when complete
+ */
+function toggle(command?: 'off' | 'on'): void {
+  // see: https://yarnpkg.com/advanced/lifecycle-scripts#environment-variables
+  const { npm_package_json = 'package.json' } = process.env
+
+  /**
+   * Absolute path to `package.json`.
+   *
+   * @const {string} pkgfile
+   */
+  const pkgfile: string = path.resolve(npm_package_json)
+
+  /**
+   * `package.json` data.
+   *
+   * @var {PackageJson} pkg
+   */
+  let pkg: PackageJson = JSON.parse(fs.readFileSync(pkgfile, 'utf8'))
+
+  // toggle package type
+  pkg = Object.keys(pkg).reduce<PackageJson>((acc, key) => {
+    const [, type, prefix = ''] = /^((#?)type)$/.exec(key) ?? []
+
+    if (type) {
+      key = command
+        ? `${command === 'off' ? '#' : ''}type`
+        : prefix
+        ? type.replace(new RegExp('^' + prefix), '')
+        : '#' + type
+
+      acc[key] = pkg[type]!
+    } else {
+      acc[key] = pkg[key]!
+    }
+
+    return acc
+  }, {})
+
+  // rewrite package.json
+  return void fs.writeFileSync(pkgfile, JSON.stringify(pkg, null, 2) + '\n')
+}
+
+export default toggle

src/toggle.ts

@@ -887,6 +887,7 @@ __metadata:
     trash-cli: "npm:5.0.0"
     ts-dedent: "npm:2.2.0"
     ts-node: "npm:10.9.1"
+    type-fest: "npm:3.0.0"
     typescript: "npm:4.8.4"
     version-bump-prompt: "npm:6.1.0"
     vite: "npm:3.1.4"
@@ -7719,6 +7720,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"type-fest@npm:3.0.0":
+  version: 3.0.0
+  resolution: "type-fest@npm:3.0.0"
+  checksum: 9a168676bf3d1c2e063ae2a25cec083aa929ff3a38505ee1131ef088b343017dd40b2747d5b9c4fb5879b0afc725b839643797cec5a2cec01889ade71b975e49
+  languageName: node
+  linkType: hard
+
 "type-fest@npm:^0.18.0":
   version: 0.18.1
   resolution: "type-fest@npm:0.18.1"