refactor: revert codemod features and options

Author: shellscape

README.md

@@ -52,31 +52,9 @@ This plugin enforces its own set of opinionated rules:
 
 Keys in `engines` are ordered alphabetically.
 
-#### Options
-
-`enginesNode`<br>
-Type: `string`
-
-Asserts an `engines.node` property value. e.g. `{ enginesNode: '>= 10.0.0' }`. If this option is set and no `node` key exists in `engines`, it will be created.
-
-`enginesNpm`<br>
-Type: `string`
-
-Asserts an `engines.npm` property value. e.g. `{ enginesNpm: '>= 10.0.0' }`. If this option is set and no `npm` key exists in `engines`, it will be created.
-
 ### Files
 
-Keys in `files` are ordered alphabetically. Additionally, `LICENSE` and `README.md` are added to `files` if they are missing. This plugin prefers implicit declaration of those files, even though they are included in a package automatically by `npm`.
-
-#### Options
-
-`filesLicense`<br>
-Type: `boolean`
-
-To prevent `LICENSE` from being added to `files`, set this option to `false`.
-
-`filesReadme`<br>
-Type: `boolean`
+Keys in `files` are ordered alphabetically.
 
 To prevent `README.md` from being added to `files`, set this option to `false`.
 

lib/index.js

@@ -12,26 +12,24 @@ const { parsers } = require('prettier/parser-babylon');
 
 const { engines } = require('./rules/engines');
 const { files } = require('./rules/files');
-const { options: pluginOptions } = require('./options');
 const { scripts } = require('./rules/scripts');
 const { sort } = require('./rules/sort');
 
 const { 'json-stringify': parser } = parsers;
 const { parse } = parser;
 const rePkg = /package\.json$/;
 
-const format = (properties, options) => {
+const format = (properties) => {
   let props = sort(properties);
-  props = engines(props, options);
-  props = files(props, options);
+  props = engines(props);
+  props = files(props);
   props = scripts(props);
 
   return props;
 };
 
 module.exports = {
   name: 'prettier-plugin-package',
-  options: pluginOptions,
   parsers: {
     'json-stringify': {
       ...parser,
@@ -42,7 +40,7 @@ module.exports = {
 
         if (rePkg.test(filepath)) {
           const { properties } = ast;
-          ast.properties = format(properties, options);
+          ast.properties = format(properties);
         }
 
         return ast;

lib/options.js

@@ -8,7 +8,7 @@
   The above copyright notice and this permission notice shall be
   included in all copies or substantial portions of this Source Code Form.
 */
-const process = (props, { enginesNode, enginesNpm }) => {
+const process = (props) => {
   const enginesIndex = props.findIndex((prop) => prop.key.value === 'engines');
 
   if (enginesIndex >= 0) {
@@ -17,34 +17,6 @@ const process = (props, { enginesNode, enginesNpm }) => {
 
     properties.sort((a, b) => (a.key.value > b.key.value ? 1 : a.key.value < b.key.value ? -1 : 0));
 
-    if (enginesNode) {
-      const nodeIndex = properties.findIndex((prop) => prop.key.value === 'node');
-
-      if (nodeIndex >= 0) {
-        properties[nodeIndex].value.value = enginesNode;
-      } else {
-        properties.push({
-          type: 'ObjectProperty',
-          key: { type: 'StringLiteral', value: 'node' },
-          value: { type: 'StringLiteral', value: enginesNode }
-        });
-      }
-    }
-
-    if (enginesNpm) {
-      const npmIndex = properties.findIndex((prop) => prop.key.value === 'npm');
-
-      if (npmIndex >= 0) {
-        properties[npmIndex].value.value = enginesNpm;
-      } else {
-        properties.push({
-          type: 'ObjectProperty',
-          key: { type: 'StringLiteral', value: 'npm' },
-          value: { type: 'StringLiteral', value: enginesNpm }
-        });
-      }
-    }
-
     engines.value.properties = properties;
 
     props.splice(enginesIndex, 0, engines);

lib/rules/engines.js

@@ -8,27 +8,41 @@
   The above copyright notice and this permission notice shall be
   included in all copies or substantial portions of this Source Code Form.
 */
-const process = (props, { filesReadme, filesLicense }) => {
+const process = (props) => {
   const filesIndex = props.findIndex((prop) => prop.key.value === 'files');
 
   if (filesIndex >= 0) {
     const [filesNode] = props.splice(filesIndex, 1);
 
+    let readme;
+    let license;
     let { elements } = filesNode.value;
 
     elements = elements
       .filter((node) => {
         const value = node.value.toLowerCase();
-        return value !== 'license' && value !== 'readme.md';
+
+        // remove LICENSE and README and add to the end later on
+        if (value === 'license') {
+          license = node;
+          return false;
+        }
+
+        if (value === 'readme' || value === 'readme.md') {
+          readme = node;
+          return false;
+        }
+
+        return true;
       })
       .sort((a, b) => (a.value > b.value ? 1 : a.value < b.value ? -1 : 0));
 
-    if (filesLicense) {
-      elements.push({ type: 'StringLiteral', value: 'LICENSE' });
+    if (readme) {
+      elements.push(readme);
     }
 
-    if (filesReadme) {
-      elements.push({ type: 'StringLiteral', value: 'README.md' });
+    if (license) {
+      elements.push(license);
     }
 
     filesNode.value.elements = elements;

lib/rules/files.js

@@ -19,61 +19,3 @@ test('default', (t) => {
 
   t.snapshot(output);
 });
-
-test('enginesNode', (t) => {
-  const options = {
-    enginesNode: '>= batcave',
-    filepath: 'package.json',
-    parser: 'json-stringify',
-    plugins: ['.']
-  };
-  const fixture = {
-    engines: {
-      npm: 'joker',
-      node: 'batman'
-    }
-  };
-
-  const input = JSON.stringify(fixture, null, 2);
-  const output = prettier.format(input, options);
-
-  t.snapshot(output);
-});
-
-test('enginesNpm', (t) => {
-  const options = {
-    enginesNpm: '>= harley',
-    filepath: 'package.json',
-    parser: 'json-stringify',
-    plugins: ['.']
-  };
-  const fixture = {
-    engines: {
-      npm: 'joker',
-      node: 'batman'
-    }
-  };
-
-  const input = JSON.stringify(fixture, null, 2);
-  const output = prettier.format(input, options);
-
-  t.snapshot(output);
-});
-
-test('missing', (t) => {
-  const options = {
-    enginesNode: '>= batcave',
-    enginesNpm: '>= harley',
-    filepath: 'package.json',
-    parser: 'json-stringify',
-    plugins: ['.']
-  };
-  const fixture = {
-    engines: {}
-  };
-
-  const input = JSON.stringify(fixture, null, 2);
-  const output = prettier.format(input, options);
-
-  t.snapshot(output);
-});

test/engines.js

@@ -8,41 +8,7 @@ test('default', (t) => {
     plugins: ['.']
   };
   const fixture = {
-    files: ['lib/']
-  };
-
-  const input = JSON.stringify(fixture, null, 2);
-  const output = prettier.format(input, options);
-
-  t.snapshot(output);
-});
-
-test('filesLicense', (t) => {
-  const options = {
-    filepath: 'package.json',
-    filesLicense: false,
-    parser: 'json-stringify',
-    plugins: ['.']
-  };
-  const fixture = {
-    files: ['lib/']
-  };
-
-  const input = JSON.stringify(fixture, null, 2);
-  const output = prettier.format(input, options);
-
-  t.snapshot(output);
-});
-
-test('filesReadme', (t) => {
-  const options = {
-    filepath: 'package.json',
-    filesReadme: false,
-    parser: 'json-stringify',
-    plugins: ['.']
-  };
-  const fixture = {
-    files: ['lib/']
+    files: ['README.md', 'LICENSE', 'lib/']
   };
 
   const input = JSON.stringify(fixture, null, 2);

test/files.js

@@ -15,39 +15,3 @@ Generated by [AVA](https://ava.li).
       }␊
     }␊
     `
-
-## enginesNode
-
-> Snapshot 1
-
-    `{␊
-      "engines": {␊
-        "node": ">= batcave",␊
-        "npm": "joker"␊
-      }␊
-    }␊
-    `
-
-## enginesNpm
-
-> Snapshot 1
-
-    `{␊
-      "engines": {␊
-        "node": "batman",␊
-        "npm": ">= harley"␊
-      }␊
-    }␊
-    `
-
-## missing
-
-> Snapshot 1
-
-    `{␊
-      "engines": {␊
-        "node": ">= batcave",␊
-        "npm": ">= harley"␊
-      }␊
-    }␊
-    `

test/snapshots/engines.js.md

@@ -11,31 +11,7 @@ Generated by [AVA](https://ava.li).
     `{␊
       "files": [␊
         "lib/",␊
-        "LICENSE",␊
-        "README.md"␊
-      ]␊
-    }␊
-    `
-
-## filesLicense
-
-> Snapshot 1
-
-    `{␊
-      "files": [␊
-        "lib/",␊
-        "README.md"␊
-      ]␊
-    }␊
-    `
-
-## filesReadme
-
-> Snapshot 1
-
-    `{␊
-      "files": [␊
-        "lib/",␊
+        "README.md",␊
         "LICENSE"␊
       ]␊
     }␊