@bigbinary/neeto-audit-frontend 1.0.2 → 1.0.3

package/.github/pull_request_template.md

@@ -3,7 +3,7 @@
 **Checklist**
 
 - [ ] I have made corresponding changes to the documentation.
-- [ ] I have verified the functionality in some of the neeto web-apps.
+- [ ] I have verified the functionality in some of the neeto nanos.
 - [ ] I have added the necessary label (patch/minor/major - If package publish
       is required).
 

package/common/.husky/helpers/neeto_audit_frontend.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+neeto_audit_frontend() {
+  npx neeto-audit-frontend
+}

package/common/.husky/pre-push

@@ -1,5 +1,7 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 . "$(dirname "$0")/helpers/prevent_pushing_to_main.sh"
+. "$(dirname "$0")/helpers/neeto_audit_frontend.sh"
 
 prevent_pushing_to_main
+neeto_audit_frontend

package/common/recommendedDependencies/frontend.js

@@ -10,6 +10,7 @@ const DEV_DEPENDENCIES = {
   "@babel/runtime": "7.22.6",
   "@bigbinary/babel-preset-neeto": "1.0.3",
   "@bigbinary/eslint-plugin-neeto": "1.0.64",
+  "@bigbinary/neeto-audit-frontend": "1.0.3",
   "@bigbinary/neeto-commons-frontend": "2.0.94",
   "@bigbinary/neeto-filters-frontend": "2.11.18",
   "@bigbinary/neeto-icons": "1.12.3",

package/dist/index.js

@@ -1679,6 +1679,90 @@ _curry1(function toString(val) {
   return _toString(val, []);
 });
 
+var XMap =
+/*#__PURE__*/
+function () {
+  function XMap(f, xf) {
+    this.xf = xf;
+    this.f = f;
+  }
+
+  XMap.prototype['@@transducer/init'] = _xfBase.init;
+  XMap.prototype['@@transducer/result'] = _xfBase.result;
+
+  XMap.prototype['@@transducer/step'] = function (result, input) {
+    return this.xf['@@transducer/step'](result, this.f(input));
+  };
+
+  return XMap;
+}();
+
+var _xmap = function _xmap(f) {
+  return function (xf) {
+    return new XMap(f, xf);
+  };
+};
+
+/**
+ * Takes a function and
+ * a [functor](https://github.com/fantasyland/fantasy-land#functor),
+ * applies the function to each of the functor's values, and returns
+ * a functor of the same shape.
+ *
+ * Ramda provides suitable `map` implementations for `Array` and `Object`,
+ * so this function may be applied to `[1, 2, 3]` or `{x: 1, y: 2, z: 3}`.
+ *
+ * Dispatches to the `map` method of the second argument, if present.
+ *
+ * Acts as a transducer if a transformer is given in list position.
+ *
+ * Also treats functions as functors and will compose them together.
+ *
+ * @func
+ * @memberOf R
+ * @since v0.1.0
+ * @category List
+ * @sig Functor f => (a -> b) -> f a -> f b
+ * @param {Function} fn The function to be called on every element of the input `list`.
+ * @param {Array} list The list to be iterated over.
+ * @return {Array} The new list.
+ * @see R.transduce, R.addIndex, R.pluck, R.project
+ * @example
+ *
+ *      const double = x => x * 2;
+ *
+ *      R.map(double, [1, 2, 3]); //=> [2, 4, 6]
+ *
+ *      R.map(double, {x: 1, y: 2, z: 3}); //=> {x: 2, y: 4, z: 6}
+ * @symb R.map(f, [a, b]) = [f(a), f(b)]
+ * @symb R.map(f, { x: a, y: b }) = { x: f(a), y: f(b) }
+ * @symb R.map(f, functor_o) = functor_o.map(f)
+ */
+
+var map =
+/*#__PURE__*/
+_curry2(
+/*#__PURE__*/
+_dispatchable(['fantasy-land/map', 'map'], _xmap, function map(fn, functor) {
+  switch (Object.prototype.toString.call(functor)) {
+    case '[object Function]':
+      return curryN(functor.length, function () {
+        return fn.call(this, functor.apply(this, arguments));
+      });
+
+    case '[object Object]':
+      return _arrayReduce(function (acc, key) {
+        acc[key] = fn(functor[key]);
+        return acc;
+      }, {}, keys(functor));
+
+    default:
+      return _map(fn, functor);
+  }
+}));
+
+var map$1 = map;
+
 function _isString(x) {
   return Object.prototype.toString.call(x) === '[object String]';
 }
@@ -1892,6 +1976,39 @@ _curry3(function eqProps(prop, obj1, obj2) {
 
 var eqProps$1 = eqProps;
 
+/**
+ * Creates a new object from a list key-value pairs. If a key appears in
+ * multiple pairs, the rightmost pair is included in the object.
+ *
+ * @func
+ * @memberOf R
+ * @since v0.3.0
+ * @category List
+ * @sig [[k,v]] -> {k: v}
+ * @param {Array} pairs An array of two-element arrays that will be the keys and values of the output object.
+ * @return {Object} The object made by pairing up `keys` and `values`.
+ * @see R.toPairs, R.pair
+ * @example
+ *
+ *      R.fromPairs([['a', 1], ['b', 2], ['c', 3]]); //=> {a: 1, b: 2, c: 3}
+ */
+
+var fromPairs =
+/*#__PURE__*/
+_curry1(function fromPairs(pairs) {
+  var result = {};
+  var idx = 0;
+
+  while (idx < pairs.length) {
+    result[pairs[idx][0]] = pairs[idx][1];
+    idx += 1;
+  }
+
+  return result;
+});
+
+var fromPairs$1 = fromPairs;
+
 /**
  * Given an `arity` (Number) and a `name` (String) the `invoker` function
  * returns a curried function that takes `arity` arguments and a `context`
@@ -1951,6 +2068,39 @@ _curry2(function invoker(arity, method) {
 
 var invoker$1 = invoker;
 
+/**
+ * See if an object (i.e. `val`) is an instance of the supplied constructor. This
+ * function will check up the inheritance chain, if any.
+ * If `val` was created using `Object.create`, `R.is(Object, val) === true`.
+ *
+ * @func
+ * @memberOf R
+ * @since v0.3.0
+ * @category Type
+ * @sig (* -> {*}) -> a -> Boolean
+ * @param {Object} ctor A constructor
+ * @param {*} val The value to test
+ * @return {Boolean}
+ * @example
+ *
+ *      R.is(Object, {}); //=> true
+ *      R.is(Number, 1); //=> true
+ *      R.is(Object, 1); //=> false
+ *      R.is(String, 's'); //=> true
+ *      R.is(String, new String('')); //=> true
+ *      R.is(Object, new String('')); //=> true
+ *      R.is(Object, 's'); //=> false
+ *      R.is(Number, {}); //=> false
+ */
+
+var is =
+/*#__PURE__*/
+_curry2(function is(Ctor, val) {
+  return val instanceof Ctor || val != null && (val.constructor === Ctor || Ctor.name === 'Object' && typeof val === 'object');
+});
+
+var is$1 = is;
+
 /**
  * Returns `true` if the given value is its type's empty value; `false`
  * otherwise.
@@ -2200,6 +2350,41 @@ var split =
 invoker$1(1, 'split');
 var split$1 = split;
 
+/**
+ * Converts an object into an array of key, value arrays. Only the object's
+ * own properties are used.
+ * Note that the order of the output array is not guaranteed to be consistent
+ * across different JS platforms.
+ *
+ * @func
+ * @memberOf R
+ * @since v0.4.0
+ * @category Object
+ * @sig {String: *} -> [[String,*]]
+ * @param {Object} obj The object to extract from
+ * @return {Array} An array of key, value arrays from the object's own properties.
+ * @see R.fromPairs, R.keys, R.values
+ * @example
+ *
+ *      R.toPairs({a: 1, b: 2, c: 3}); //=> [['a', 1], ['b', 2], ['c', 3]]
+ */
+
+var toPairs =
+/*#__PURE__*/
+_curry1(function toPairs(obj) {
+  var pairs = [];
+
+  for (var prop in obj) {
+    if (_has(prop, obj)) {
+      pairs[pairs.length] = [prop, obj[prop]];
+    }
+  }
+
+  return pairs;
+});
+
+var toPairs$1 = toPairs;
+
 const run$1 = util.promisify(exec);
 
 const execute = async (command, debug) => {
@@ -2244,9 +2429,8 @@ const createOrReplaceFile = async ({
 
 const renderErrors = (errors = [], isAutoFixFlagPresent = false) => {
   console.log();
-  console.log(chalk$1.red("Errors:"));
-  console.log(chalk$1.red(`- ${errors.join("\n- ")}`));
-  console.log();
+  console.log(chalk$1.bgRed("ERRORS"));
+  console.log(chalk$1.red(` \u2022 ${errors.join("\n \u2022 ")}`));
   if (!isAutoFixFlagPresent) process.exitCode = 1;
 };
 
@@ -2514,6 +2698,7 @@ const DEV_DEPENDENCIES$2 = {
   "@babel/runtime": "7.22.6",
   "@bigbinary/babel-preset-neeto": "1.0.3",
   "@bigbinary/eslint-plugin-neeto": "1.0.64",
+  "@bigbinary/neeto-audit-frontend": "1.0.3",
   "@bigbinary/neeto-commons-frontend": "2.0.94",
   "@bigbinary/neeto-filters-frontend": "2.11.18",
   "@bigbinary/neeto-icons": "1.12.3",
@@ -2671,6 +2856,15 @@ const getOutdatedPackages = (nanoType, packageJson) =>
     return { type, outdatedPackages: Object.keys(outdatedPackages) };
   });
 
+const sortByKey = (object) =>
+  map$1(
+    (value) =>
+      is$1(Object, value) && !Array.isArray(value)
+        ? fromPairs$1(toPairs$1(value).sort())
+        : value,
+    object
+  );
+
 const recommendedPackageVersions = async (debug) => {
   const packageJson = await getPackageJson(debug);
 
@@ -2680,7 +2874,8 @@ const recommendedPackageVersions = async (debug) => {
 
   const fix = async (debug) => {
     const recommendedVersions = recommendedDependencies[nanoType];
-    const newPackageJson = mergeDeepRight$1(packageJson, recommendedVersions);
+    let newPackageJson = mergeDeepRight$1(packageJson, recommendedVersions);
+    newPackageJson = sortByKey(newPackageJson);
 
     await createOrReplaceFile({
       relativeFilePath: PACKAGE_JSON_PATH,
@@ -6094,6 +6289,7 @@ const run = async () => {
 
   errors.length > 0 && renderErrors(errors, autoFix);
   autoFix && console.log(chalk$1.green("All issues have been fixed!"));
+  console.log();
 };
 
 run();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-audit-frontend",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Audits neeto frontend codebase for issues and suggests a fix.",
   "type": "module",
   "bin": "./dist/index.js",

package/src/cli.js

@@ -32,6 +32,7 @@ const run = async () => {
 
   errors.length > 0 && renderErrors(errors, autoFix);
   autoFix && console.log(chalk.green("All issues have been fixed!"));
+  console.log();
 };
 
 run();

package/src/utils/index.js

@@ -50,9 +50,8 @@ export const createOrReplaceFile = async ({
 
 export const renderErrors = (errors = [], isAutoFixFlagPresent = false) => {
   console.log();
-  console.log(chalk.red("Errors:"));
-  console.log(chalk.red(`- ${errors.join("\n- ")}`));
-  console.log();
+  console.log(chalk.bgRed("ERRORS"));
+  console.log(chalk.red(` \u2022 ${errors.join("\n \u2022 ")}`));
   if (!isAutoFixFlagPresent) process.exitCode = 1;
 };
 

package/src/verifiers/recommendedPackageVersions/index.js

@@ -1,5 +1,10 @@
 import { identity, isEmpty, mergeDeepRight } from "ramda";
-import { getNanoType, getOutdatedPackages, getPackageJson } from "./utils.js";
+import {
+  getNanoType,
+  getOutdatedPackages,
+  getPackageJson,
+  sortByKey,
+} from "./utils.js";
 import { createOrReplaceFile, execute } from "../../utils/index.js";
 import recommendedDependencies from "../../../common/recommendedDependencies/index.js";
 import { PACKAGE_JSON_PATH } from "./constants.js";
@@ -13,7 +18,8 @@ const recommendedPackageVersions = async (debug) => {
 
   const fix = async (debug) => {
     const recommendedVersions = recommendedDependencies[nanoType];
-    const newPackageJson = mergeDeepRight(packageJson, recommendedVersions);
+    let newPackageJson = mergeDeepRight(packageJson, recommendedVersions);
+    newPackageJson = sortByKey(newPackageJson);
 
     await createOrReplaceFile({
       relativeFilePath: PACKAGE_JSON_PATH,

package/src/verifiers/recommendedPackageVersions/utils.js

@@ -2,7 +2,18 @@ import recommendedDependencies from "../../../common/recommendedDependencies/ind
 import { getFileContent } from "../../utils/index.js";
 import { DEPENDENCY_TYPES, PACKAGE_JSON_PATH } from "./constants.js";
 
-import { eqProps, last, pickBy, mapObjIndexed, not, split } from "ramda";
+import {
+  eqProps,
+  last,
+  pickBy,
+  mapObjIndexed,
+  not,
+  split,
+  map,
+  is,
+  fromPairs,
+  toPairs,
+} from "ramda";
 
 export const getPackageJson = async (debug) => {
   const packageJsonContent = await getFileContent({
@@ -28,3 +39,12 @@ export const getOutdatedPackages = (nanoType, packageJson) =>
 
     return { type, outdatedPackages: Object.keys(outdatedPackages) };
   });
+
+export const sortByKey = (object) =>
+  map(
+    (value) =>
+      is(Object, value) && !Array.isArray(value)
+        ? fromPairs(toPairs(value).sort())
+        : value,
+    object
+  );