Merge pull request #6 from razor-x/v2

Version 2

Author: razor-x

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.0.0] / 2022-09-14
+
+### Changed
+
+- (**Breaking**) Rename npm package to config-curator.
+- (**Breaking**) Require Node.js v14.15.0 or higher.
+- (**Breaking**) Convert to pure ES module.
+
 ## [1.1.0] / 2020-11-19
 
 ### Changed
@@ -37,7 +45,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Initial release.
 
-[Unreleased]: https://github.com/razor-x/config-curator/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/razor-x/config-curator/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/razor-x/config-curator/compare/v1.1.0...v2.0.0
 [1.1.0]: https://github.com/razor-x/config-curator/compare/v1.0.3...v1.1.0
 [1.0.3]: https://github.com/razor-x/config-curator/compare/v1.0.2...v1.0.3
 [1.0.2]: https://github.com/razor-x/config-curator/compare/v1.0.1...v1.0.2

README.md

@@ -1,7 +1,7 @@
 # ☄️ Config Curator
 
-[![npm](https://img.shields.io/npm/v/@rxrc/curator.svg)](https://www.npmjs.com/package/@rxrc/curator)
-[![github](https://img.shields.io/badge/github-razor-x/config-curator-blue.svg)](https://github.com/razor-x/config-curator)
+[![npm](https://img.shields.io/npm/v/config-curator.svg)](https://www.npmjs.com/package/config-curator)
+[![main](https://github.com/razor-x/config-curator/actions/workflows/main.yml/badge.svg)](https://github.com/razor-x/config-curator/actions/workflows/main.yml)
 
 **CLI tool for installing static configuration or dotfiles.**
 
@@ -52,7 +52,7 @@
 1. Add this as a development dependency to your project using [npm] with
 
     ```
-    $ npm install --save-dev @rxrc/curator
+    $ npm install --save-dev config-curator
     ```
 
 2. Add a [script][npm scripts] to your `package.json` with `"curator": "curator"`
@@ -86,9 +86,7 @@ and run the `curator` command to install the configuration.
 ```js
 /* manifest.js */
 
-'use strict'
-
-const os = require('os')
+import os from 'os'
 
 const targetRoot = os.homedir()
 
@@ -135,35 +133,39 @@ const symlinks = [
   }
 ]
 
-module.exports = { targetRoot, unlinks, directories, files, symlinks }
+export default {
+  targetRoot,
+  unlinks,
+  directories,
+  files,
+  symlinks
+}
 ```
 
 #### Complete manifest API
 
 ```js
 /* manifest.js */
 
-'use strict'
+import os from 'os'
 
 /* Prefix for all source paths
  * except for unlinks and symlinks which use targetRoot below.
  *
- * Use __dirname to refer to the location of this file
- * and process.cwd() for the current working directory.
+ * Use process.cwd() for the current working directory.
  *
  * Default: the current working directory.
  */
-const originRoot = require('os').homedir()
+const originRoot = os.homedir()
 
 /* Prefix for all destination paths.
  * For unlinks and symlinks, the source is also prefixed.
  *
- * Use __dirname to refer to the location of this file
- * and process.cwd() for the current working directory.
+ * Use process.cwd() for the current working directory.
  *
  * Default: a ./dest folder under the current working directory.
  */
-const targetRoot = require('os').homedir()
+const targetRoot = os.homedir()
 
 /* Package lookup backend to use:
  * pacman, dpkg, homebrew, pkgng, or noop.
@@ -334,7 +336,7 @@ const symlinks = [
  * or async function that returns the plain object.
  * Simply do not export an option to use the default.
  */
-module.exports = {
+export default {
   unlinks,
   directories,
   files,

bin/curator.js

@@ -1,23 +1,13 @@
 #!/usr/bin/env node
 
-'use strict'
+import path from 'path'
 
-const path = require('path')
+import curator from '../lib/index.js'
 
-const curator = require('../lib')
+const manifestPath = process.argv[2]
+  ? path.resolve(process.argv[2])
+  : path.resolve(process.cwd(), 'manifest.js')
 
-if (require.main === module) {
-  const manifest = process.argv[2]
-    ? path.resolve(process.argv[2])
-    : path.resolve(process.cwd(), 'manifest.js')
+const manifest = await import(manifestPath)
 
-  curator(require(manifest))
-    .then(() => {
-      process.exit()
-    })
-    .catch((err) => {
-      console.log()
-      console.error(err)
-      process.exit(1)
-    })
-}
+await curator(manifest.default)

lib/exec.js

@@ -1,8 +1,6 @@
-'use strict'
+import { exec } from 'child_process'
 
-const { exec } = require('child_process')
-
-module.exports = (cmd = 'echo') =>
+export default (cmd = 'echo') =>
   new Promise((resolve, reject) => {
     exec(cmd, (err, stdout, stderr) => {
       if (err) return reject(err)

lib/index.js

@@ -1,13 +1,11 @@
-'use strict'
+import os from 'os'
 
-const os = require('os')
+import createPackageChecker from './package-checker.js'
+import createIo from './io/index.js'
+import normalize from './normalize.js'
+import install from './install.js'
 
-const createPackageChecker = require('./package-checker')
-const createIo = require('./io')
-const normalize = require('./normalize')
-const install = require('./install')
-
-module.exports = async (manifestOrFunction) => {
+export default async (manifestOrFunction) => {
   const promiseForManifest =
     typeof manifestOrFunction === 'function'
       ? manifestOrFunction()

lib/install.js

@@ -1,5 +1,3 @@
-'use strict'
-
 const isEmpty = (x) => x.length === 0
 
 const makeGroups = (key, items) => {
@@ -94,7 +92,7 @@ const installSymlink =
       }
     }
 
-module.exports = async ({ unlinks, directories, files, symlinks, io }) => {
+export default async ({ unlinks, directories, files, symlinks, io }) => {
   await Promise.all([...directories, ...files].map(checkAccess(io)))
   console.log('>> Unlinking paths')
   if (isEmpty(unlinks)) console.log('Nothing to do')

lib/io/index.js

@@ -1,9 +1,7 @@
-'use strict'
+import os from 'os'
 
-const os = require('os')
-
-const linux = require('./linux')
-const noop = require('./noop')
+import linux from './linux.js'
+import noop from './noop.js'
 
 const has = (obj, k) => Object.prototype.hasOwnProperty.call(obj, k)
 
@@ -19,7 +17,7 @@ const getDefaultType = () => {
   return 'noop'
 }
 
-module.exports = (type) => {
+export default (type) => {
   const typeIsNotNil = type != null
   const typeIsCustomObject = typeIsNotNil && typeof type === 'object'
   const typeIsNotSupported = typeIsNotNil && !has(types, type)

lib/io/linux.js

@@ -1,14 +1,17 @@
-'use strict'
+import path from 'path'
 
-const path = require('path')
+import exec from '../exec.js'
+import {
+  checkAccess,
+  chmod,
+  copyFile as copyFileShared,
+  makeSymlink as makeSymlinkShared
+} from './shared.js'
 
-const exec = require('../exec')
-const { checkAccess, chmod, copyFile, makeSymlink } = require('./shared')
+const makeDirRecursive = ({ target }) => exec(`mkdir -p ${target}`)
 
 const unlink = ({ target }) => exec(`rm -rf ${target}`)
 
-const makeDirRecursive = ({ target }) => exec(`mkdir -p ${target}`)
-
 const chmodRecursive = ({ fmode, dmode, target }) =>
   Promise.all([
     exec(`find ${target} -type f -exec chmod ${fmode.toString(8)} {} +`),
@@ -30,18 +33,18 @@ const overwriteDirectory = async ({ source, destination }) => {
   return exec(`rsync -rtc --del --links ${source}/ ${destination}`)
 }
 
-const copyFileLiunx = async ({ source, destination }) => {
+const copyFile = async ({ source, destination }) => {
   await makeDirRecursive({ target: path.dirname(destination) })
-  return copyFile({ source, destination })
+  return copyFileShared({ source, destination })
 }
 
-const makeSymlinkLinux = async ({ source, destination }) => {
+const makeSymlink = async ({ source, destination }) => {
   await makeDirRecursive({ target: path.dirname(source) })
   await unlink({ target: source })
-  return makeSymlink({ source, destination })
+  return makeSymlinkShared({ source, destination })
 }
 
-module.exports = {
+export default {
   checkAccess,
   unlink,
   chmod,
@@ -51,6 +54,6 @@ module.exports = {
   chgrp,
   chgrpRecursive,
   overwriteDirectory,
-  copyFile: copyFileLiunx,
-  makeSymlink: makeSymlinkLinux
+  copyFile,
+  makeSymlink
 }

lib/io/noop.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const path = require('path')
+import path from 'path'
 
 const checkAccess = ({ target }) => {
   console.log(`Access ok for ${target}`)
@@ -56,7 +54,7 @@ const makeSymlink = ({ source, destination }) => {
   console.log(`Make symlink from ${source} to ${destination}`)
 }
 
-module.exports = {
+export default {
   checkAccess,
   unlink,
   chmod,

lib/io/shared.js

@@ -1,22 +1,12 @@
-'use strict'
+import fs, { promises as fsPromises } from 'fs'
 
-const fs = require('fs')
-const { promisify } = require('util')
+export const checkAccess = ({ target }) =>
+  fsPromises.access(target, fs.constants.R_OK)
 
-const fsAccessAsync = promisify(fs.access)
-const fsChmodAsync = promisify(fs.chmod)
-const fsCopyFileAsync = promisify(fs.copyFile)
-const fsSymlink = promisify(fs.symlink)
+export const chmod = ({ mode, target }) => fsPromises.chmod(target, mode)
 
-const checkAccess = ({ target }) => fsAccessAsync(target, fs.constants.R_OK)
-const chmod = ({ mode, target }) => fsChmodAsync(target, mode)
-const copyFile = ({ source, destination }) =>
-  fsCopyFileAsync(source, destination)
-const makeSymlink = ({ source, destination }) => fsSymlink(destination, source)
+export const copyFile = ({ source, destination }) =>
+  fsPromises.copyFile(source, destination)
 
-module.exports = {
-  checkAccess,
-  chmod,
-  copyFile,
-  makeSymlink
-}
+export const makeSymlink = ({ source, destination }) =>
+  fsPromises.symlink(destination, source)