chore: expand test coverage

- add coverage for most implemented non-`npm install` behavior
- add a wallabyjs config file
- add [`read-package-json`](https://npm.im/read-package-json) for some normalization
- rename fixtures, reorganize tests somewhat
- add a helper function to run `createPackageJson` in silent mode w/ `barePrompt`
- change some assertions to use `deepStrictEqual`
- add TODO list to `README.md`
- better handling of `scripts`, `keywords`, and `repository` fields
- update build matrix

Author: boneskull

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [8.x, 10.x, 12.x]
+        node-version: [10.x, 12.x, 14.x, 15.x]
     steps:
     - uses: actions/checkout@v1
     - name: Use Node.js ${{ matrix.node-version }}

.wallaby.js

@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = () => {
+  return {
+    files: ['package.json', 'index.js', 'lib/**/*.js', 'bin/*', 'test/fixtures/**/*', 'test/fixtures/**/.*' ],
+    tests: ['test/*.js'],
+    env: {
+      type: 'node',
+      runner: 'node'
+    },
+    testFramework: 'mocha'
+  };
+};

README.md

@@ -89,3 +89,26 @@ const createPackageJson = require('create-package-json')
   console.log(pkg) // The json after writing and installing
 })()
 ```
+
+## Implementation TODO
+
+> See [`package.json` docs](https://docs.npmjs.com/files/package.json)
+
+- [ ] `exports`
+- [ ] `bin`
+- [ ] `funding`
+- [ ] `files`
+- [ ] `browser`
+- [ ] `directories`
+- [ ] `config`
+- [ ] `dependencies`
+- [ ] `devDependencies`
+- [ ] `bundledDependencies`
+- [ ] `optionalDependencies`
+- [ ] `engines`
+- [ ] `os`
+- [ ] `cpu`
+- [ ] `publishConfig`
+- [ ] `homepage`
+- [ ] `bugs`
+- [ ] `contributors`

index.js

@@ -3,6 +3,8 @@ const path = require('path')
 const fs = require('fs-extra')
 const opta = require('opta')
 const parseList = require('safe-parse-list')
+const { promisify } = require('util')
+const readPkg = promisify(require('read-package-json'))
 const { Loggerr } = require('loggerr')
 const packageName = require('./lib/package-name')
 const git = require('./lib/git')
@@ -226,7 +228,7 @@ async function readPackageJson (options, { log } = {}) {
   const opts = options.values()
   let pkg = {}
   try {
-    pkg = await fs.readJSON(path.resolve(opts.cwd, 'package.json'))
+    pkg = await readPkg(path.resolve(opts.cwd, 'package.json'))
     log.debug('Read existing package.json', pkg)
   } catch (e) {
     // @TODO log this?
@@ -240,9 +242,10 @@ async function readPackageJson (options, { log } = {}) {
     type: pkg.type,
     author: pkg.author,
     description: pkg.description,
-    repository: pkg.repository && pkg.repository.url,
+    repository: pkg.repository,
     keywords: pkg.keywords,
-    scripts: Object.assign({}, pkg.scripts, opts.scripts)
+    scripts: pkg.scripts,
+    license: pkg.license
   })
 
   return pkg
@@ -258,21 +261,27 @@ async function format (opts, pkg = {}) {
   pkg.type = opts.type || 'commonjs'
 
   if (opts.keywords && opts.keywords.length) {
-    pkg.keywords = opts.keywords
+    // TODO: extra parsing going on here due to wesleytodd/opta#1
+    pkg.keywords = uniquify([...(pkg.keywords || []), ...parseList(opts.keywords)])
   }
 
   // Scripts
   if (Object.keys(opts.scripts).length) {
-    pkg.scripts = opts.scripts
+    pkg.scripts = { ...(pkg.scripts || {}), ...opts.scripts }
   }
 
+  // TODO: to test the empty string, we need to stub git.author()
   pkg.author = opts.author || ''
   pkg.license = opts.license
 
   if (opts.repository) {
-    pkg.repository = {
-      type: 'git',
-      url: opts.repository
+    if (typeof opts.repository === 'string') {
+      pkg.repository = {
+        type: 'git',
+        url: opts.repository
+      }
+    } else {
+      pkg.repository = opts.repository
     }
   }
 
@@ -306,6 +315,7 @@ async function format (opts, pkg = {}) {
 }
 
 module.exports.write = write
+// TODO: look at https://npm.im/json-file-plus for writing
 async function write (pkgPath, opts, pkg, { log } = {}) {
   // Write package json
   log.info(`Writing package.json\n${pkgPath}`)
@@ -334,3 +344,7 @@ async function write (pkgPath, opts, pkg, { log } = {}) {
   // Read full package back to return
   return fs.readJSON(pkgPath)
 }
+
+function uniquify (arr = []) {
+  return [...new Set(arr)]
+}

package.json

@@ -37,6 +37,7 @@
     "loggerr": "^3.0.0",
     "npm-package-arg": "^8.0.1",
     "opta": "^0.0.6",
+    "read-package-json": "^3.0.0",
     "safe-parse-list": "^0.1.1",
     "validate-npm-package-name": "^3.0.0"
   },

test/fixtures/existing/package.json …st/fixtures/ignore-existing/package.jsontest/fixtures/existing/package.json renamed to test/fixtures/ignore-existing/package.json test/fixtures/existing/package.json renamed to test/fixtures/ignore-existing/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@test/existing",
+  "version": "0.0.0",
+  "description": "A test package",
+  "main": "index.js",
+  "scripts": {
+    "test": "exit 0"
+  },
+  "author": "Test <tester@example.com>",
+  "license": "ISC",
+  "keywords": ["foo", "bar"]
+}

test/fixtures/overrides-keywords/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@test/existing",
+  "version": "0.0.0",
+  "description": "A test package",
+  "main": "index.js",
+  "scripts": {
+    "test": "exit 0"
+  },
+  "author": "Test <tester@example.com>",
+  "license": "ISC"
+}

test/fixtures/overrides-name/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@test/existing",
+  "version": "0.0.0",
+  "description": "A test package",
+  "main": "index.js",
+  "scripts": {
+    "test": "exit 0"
+  },
+  "author": "Test <tester@example.com>",
+  "license": "ISC",
+  "repository": "https://git-landfill.com/garbage"
+}

test/fixtures/overrides-repository-string/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@test/existing",
+  "version": "0.0.0",
+  "description": "A test package",
+  "main": "index.js",
+  "scripts": {
+    "test": "exit 0"
+  },
+  "author": "Test <tester@example.com>",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://git-landfill.com/garbage"
+  }
+}