inferred-types 0.20.0 → 0.22.5

package/dist/index.js

@@ -1,42 +1,21 @@
+"use strict";
 var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
 };
-var __reExport = (target, module2, copyDefault, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
+  return to;
 };
-var __toCommonJS = /* @__PURE__ */ ((cache) => {
-  return (module2, temp) => {
-    return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
-  };
-})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
 var src_exports = {};
@@ -44,7 +23,6 @@ __export(src_exports, {
   Configurator: () => Configurator,
   ExplicitFunction: () => ExplicitFunction,
   FluentConfigurator: () => FluentConfigurator,
-  KeyStorage: () => KeyStorage,
   Model: () => Model,
   MutationIdentity: () => MutationIdentity,
   and: () => and,
@@ -54,6 +32,7 @@ __export(src_exports, {
   condition: () => condition,
   createFnWithProps: () => createFnWithProps,
   createMutationFunction: () => createMutationFunction,
+  defineProperties: () => defineProperties,
   defineType: () => defineType,
   dictToKv: () => dictToKv,
   dictionaryTransform: () => dictionaryTransform,
@@ -71,7 +50,6 @@ __export(src_exports, {
   isBoolean: () => isBoolean,
   isFalse: () => isFalse,
   isFunction: () => isFunction,
-  isLiteral: () => isLiteral,
   isNull: () => isNull,
   isNumber: () => isNumber,
   isObject: () => isObject,
@@ -97,9 +75,9 @@ __export(src_exports, {
   typeApi: () => typeApi,
   uuid: () => uuid,
   valueTypes: () => valueTypes,
-  valuesOfProp: () => valuesOfProp,
   withValue: () => withValue
 });
+module.exports = __toCommonJS(src_exports);
 
 // src/Mutation/MutationFunction.ts
 function createMutationFunction(state) {
@@ -196,11 +174,31 @@ function arrayToKeyLookup(...keys2) {
   return obj;
 }
 
+// src/utility/dictionary/defineProperties.ts
+function defineProperties(obj) {
+  return {
+    ro(prop, errorMsg) {
+      Object.defineProperty(obj, prop, {
+        writable: false,
+        set(v) {
+          const message = errorMsg ? errorMsg(prop, v) : `The ${String(
+            prop
+          )} is readonly but an attempt was made to change it's value to "${JSON.stringify(
+            v
+          )}"!`;
+          throw new Error(message);
+        }
+      });
+      return obj;
+    }
+  };
+}
+
 // src/utility/dictionary/dictionaryTransform.ts
 function dictionaryTransform(input, transform) {
   return keys(input).reduce((acc, i) => {
     const key = i;
-    return __spreadProps(__spreadValues({}, acc), { [key]: transform(input, key) });
+    return { ...acc, [key]: transform(input, key) };
   }, {});
 }
 
@@ -218,21 +216,19 @@ function entries(obj) {
 
 // src/utility/dictionary/mapValues.ts
 function mapValues(obj, valueMapper) {
-  return Object.fromEntries([...entries(obj)].map(([k, v]) => [k, valueMapper(v)]));
+  return Object.fromEntries(
+    [...entries(obj)].map(([k, v]) => [k, valueMapper(v)])
+  );
 }
 
 // src/utility/dictionary/strArrayToDict.ts
 function strArrayToDict(...strings) {
   return strings.reduce((acc, str) => {
-    acc = __spreadProps(__spreadValues({}, acc), { [str]: true });
+    acc = { ...acc, [str]: true };
     return acc;
   }, {});
 }
 
-// src/utility/dictionary/valuesOfProp.ts
-function valuesOfProp() {
-}
-
 // src/utility/dictionary/kv/dictToKv.ts
 function dictToKv(obj, _makeTuple = false) {
   return keys(obj).map((k) => {
@@ -252,7 +248,7 @@ function Configurator() {
       set(key, value) {
         const keyValue = { [key]: value };
         const config = configuration();
-        const updated = __spreadValues(__spreadValues({}, config), keyValue);
+        const updated = { ...config, ...keyValue };
         configuration = () => updated;
         return updated;
       },
@@ -276,7 +272,7 @@ function FluentConfigurator(initial = {}) {
     return {
       set(key, value) {
         const keyValue = { [key]: value };
-        const updated = __spreadValues(__spreadValues({}, keyValue), current);
+        const updated = { ...keyValue, ...current };
         return api2(updated);
       },
       done() {
@@ -285,23 +281,13 @@ function FluentConfigurator(initial = {}) {
     };
   };
   if (initial && typeof initial !== "object") {
-    throw new Error("The FluentConfigurator was passed a non-object based value as the initial value. This is not allowed.");
+    throw new Error(
+      "The FluentConfigurator was passed a non-object based value as the initial value. This is not allowed."
+    );
   }
   return initial ? api2(initial) : api2({});
 }
 
-// src/utility/state/KeyStorage.ts
-function KeyStorage() {
-  const api2 = (state) => ({
-    add: (...store) => {
-      return api2([...state, ...store]);
-    },
-    remove: (key) => api2(state.filter((i) => i !== key)),
-    done: () => state
-  });
-  return api2([]);
-}
-
 // src/utility/dictionary/kv/filterDictArray.ts
 function filterDictArray(dictArr, cb) {
   const state = Configurator();
@@ -333,8 +319,6 @@ function kvToDict(kvArr) {
 // src/utility/lists/groupBy.ts
 function groupBy(_data) {
   throw new Error("not implemented");
-  return (_groupBy) => {
-  };
 }
 
 // src/utility/literals/ExplicitFunction.ts
@@ -345,9 +329,9 @@ function ExplicitFunction(fn) {
 // src/utility/literals/arrayToObject.ts
 function arrayToObject(prop, unique) {
   const transform = (arr) => {
-    const result = unique !== false ? arr.reduce((acc, v) => __spreadProps(__spreadValues({}, acc), { [v[prop]]: v }), {}) : arr.reduce((acc, v) => {
+    const result = unique !== false ? arr.reduce((acc, v) => ({ ...acc, [v[prop]]: v }), {}) : arr.reduce((acc, v) => {
       const existing = acc[v[prop]] || [];
-      return __spreadProps(__spreadValues({}, acc), { [v[prop]]: [...existing, v] });
+      return { ...acc, [v[prop]]: [...existing, v] };
     }, {});
     return result;
   };
@@ -357,7 +341,7 @@ function arrayToObject(prop, unique) {
 // src/utility/literals/defineType.ts
 function defineType(literal2 = {}) {
   return (wide = {}) => {
-    return literal2 ? __spreadValues(__spreadValues({}, wide), literal2) : wide;
+    return literal2 ? { ...wide, ...literal2 } : wide;
   };
 }
 
@@ -366,7 +350,7 @@ var identity = (v) => v;
 
 // src/utility/literals/literal.ts
 function idLiteral(o) {
-  return __spreadProps(__spreadValues({}, o), { id: o.id });
+  return { ...o, id: o.id };
 }
 function nameLiteral(o) {
   return o;
@@ -453,8 +437,11 @@ function runtimeExtendsCheck(val, base, narrow = false) {
     case "object":
       if (val === null && base === null) {
         return true;
+      } else {
+        return keys(base).every(
+          (i) => runtimeExtendsCheck(val[i], base[i], narrow)
+        );
       }
-      return keys(base).every((i) => runtimeExtendsCheck(val[i], base[i], narrow));
   }
 }
 var ifTypeOf = (val) => ({
@@ -504,13 +491,6 @@ function isFunction(input) {
   return typeof input === "function";
 }
 
-// src/utility/runtime/conditions/isLiteral.ts
-function isLiteral(...allowed) {
-  return (i) => {
-    return !allowed.every((v) => i !== v);
-  };
-}
-
 // src/utility/runtime/conditions/isNull.ts
 function isNull(i) {
   return i === null;
@@ -621,7 +601,9 @@ function isType(t) {
 function type(fn) {
   const result = fn(typeApi());
   if (!isType(result)) {
-    throw new Error(`When using type(), the callback passed in returned an invalid type! Value returned was: ${result}`);
+    throw new Error(
+      `When using type(), the callback passed in returned an invalid type! Value returned was: ${result}`
+    );
   }
   return result;
 }
@@ -630,18 +612,18 @@ function type(fn) {
 function withValue(td) {
   return (obj) => {
     const t = type(td);
-    return Object.fromEntries([...entries(obj)].filter(([_key, value]) => {
-      return t.typeGuard(value);
-    }));
+    return Object.fromEntries(
+      [...entries(obj)].filter(([_key, value]) => {
+        return t.typeGuard(value);
+      })
+    );
   };
 }
-module.exports = __toCommonJS(src_exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Configurator,
   ExplicitFunction,
   FluentConfigurator,
-  KeyStorage,
   Model,
   MutationIdentity,
   and,
@@ -651,6 +633,7 @@ module.exports = __toCommonJS(src_exports);
   condition,
   createFnWithProps,
   createMutationFunction,
+  defineProperties,
   defineType,
   dictToKv,
   dictionaryTransform,
@@ -668,7 +651,6 @@ module.exports = __toCommonJS(src_exports);
   isBoolean,
   isFalse,
   isFunction,
-  isLiteral,
   isNull,
   isNumber,
   isObject,
@@ -694,6 +676,5 @@ module.exports = __toCommonJS(src_exports);
   typeApi,
   uuid,
   valueTypes,
-  valuesOfProp,
   withValue
 });

package/dist/index.mjs

@@ -1,23 +1,3 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-
 // src/Mutation/MutationFunction.ts
 function createMutationFunction(state) {
   return (mutationIdentity) => {
@@ -113,11 +93,31 @@ function arrayToKeyLookup(...keys2) {
   return obj;
 }
 
+// src/utility/dictionary/defineProperties.ts
+function defineProperties(obj) {
+  return {
+    ro(prop, errorMsg) {
+      Object.defineProperty(obj, prop, {
+        writable: false,
+        set(v) {
+          const message = errorMsg ? errorMsg(prop, v) : `The ${String(
+            prop
+          )} is readonly but an attempt was made to change it's value to "${JSON.stringify(
+            v
+          )}"!`;
+          throw new Error(message);
+        }
+      });
+      return obj;
+    }
+  };
+}
+
 // src/utility/dictionary/dictionaryTransform.ts
 function dictionaryTransform(input, transform) {
   return keys(input).reduce((acc, i) => {
     const key = i;
-    return __spreadProps(__spreadValues({}, acc), { [key]: transform(input, key) });
+    return { ...acc, [key]: transform(input, key) };
   }, {});
 }
 
@@ -135,21 +135,19 @@ function entries(obj) {
 
 // src/utility/dictionary/mapValues.ts
 function mapValues(obj, valueMapper) {
-  return Object.fromEntries([...entries(obj)].map(([k, v]) => [k, valueMapper(v)]));
+  return Object.fromEntries(
+    [...entries(obj)].map(([k, v]) => [k, valueMapper(v)])
+  );
 }
 
 // src/utility/dictionary/strArrayToDict.ts
 function strArrayToDict(...strings) {
   return strings.reduce((acc, str) => {
-    acc = __spreadProps(__spreadValues({}, acc), { [str]: true });
+    acc = { ...acc, [str]: true };
     return acc;
   }, {});
 }
 
-// src/utility/dictionary/valuesOfProp.ts
-function valuesOfProp() {
-}
-
 // src/utility/dictionary/kv/dictToKv.ts
 function dictToKv(obj, _makeTuple = false) {
   return keys(obj).map((k) => {
@@ -169,7 +167,7 @@ function Configurator() {
       set(key, value) {
         const keyValue = { [key]: value };
         const config = configuration();
-        const updated = __spreadValues(__spreadValues({}, config), keyValue);
+        const updated = { ...config, ...keyValue };
         configuration = () => updated;
         return updated;
       },
@@ -193,7 +191,7 @@ function FluentConfigurator(initial = {}) {
     return {
       set(key, value) {
         const keyValue = { [key]: value };
-        const updated = __spreadValues(__spreadValues({}, keyValue), current);
+        const updated = { ...keyValue, ...current };
         return api2(updated);
       },
       done() {
@@ -202,23 +200,13 @@ function FluentConfigurator(initial = {}) {
     };
   };
   if (initial && typeof initial !== "object") {
-    throw new Error("The FluentConfigurator was passed a non-object based value as the initial value. This is not allowed.");
+    throw new Error(
+      "The FluentConfigurator was passed a non-object based value as the initial value. This is not allowed."
+    );
   }
   return initial ? api2(initial) : api2({});
 }
 
-// src/utility/state/KeyStorage.ts
-function KeyStorage() {
-  const api2 = (state) => ({
-    add: (...store) => {
-      return api2([...state, ...store]);
-    },
-    remove: (key) => api2(state.filter((i) => i !== key)),
-    done: () => state
-  });
-  return api2([]);
-}
-
 // src/utility/dictionary/kv/filterDictArray.ts
 function filterDictArray(dictArr, cb) {
   const state = Configurator();
@@ -250,8 +238,6 @@ function kvToDict(kvArr) {
 // src/utility/lists/groupBy.ts
 function groupBy(_data) {
   throw new Error("not implemented");
-  return (_groupBy) => {
-  };
 }
 
 // src/utility/literals/ExplicitFunction.ts
@@ -262,9 +248,9 @@ function ExplicitFunction(fn) {
 // src/utility/literals/arrayToObject.ts
 function arrayToObject(prop, unique) {
   const transform = (arr) => {
-    const result = unique !== false ? arr.reduce((acc, v) => __spreadProps(__spreadValues({}, acc), { [v[prop]]: v }), {}) : arr.reduce((acc, v) => {
+    const result = unique !== false ? arr.reduce((acc, v) => ({ ...acc, [v[prop]]: v }), {}) : arr.reduce((acc, v) => {
       const existing = acc[v[prop]] || [];
-      return __spreadProps(__spreadValues({}, acc), { [v[prop]]: [...existing, v] });
+      return { ...acc, [v[prop]]: [...existing, v] };
     }, {});
     return result;
   };
@@ -274,7 +260,7 @@ function arrayToObject(prop, unique) {
 // src/utility/literals/defineType.ts
 function defineType(literal2 = {}) {
   return (wide = {}) => {
-    return literal2 ? __spreadValues(__spreadValues({}, wide), literal2) : wide;
+    return literal2 ? { ...wide, ...literal2 } : wide;
   };
 }
 
@@ -283,7 +269,7 @@ var identity = (v) => v;
 
 // src/utility/literals/literal.ts
 function idLiteral(o) {
-  return __spreadProps(__spreadValues({}, o), { id: o.id });
+  return { ...o, id: o.id };
 }
 function nameLiteral(o) {
   return o;
@@ -370,8 +356,11 @@ function runtimeExtendsCheck(val, base, narrow = false) {
     case "object":
       if (val === null && base === null) {
         return true;
+      } else {
+        return keys(base).every(
+          (i) => runtimeExtendsCheck(val[i], base[i], narrow)
+        );
       }
-      return keys(base).every((i) => runtimeExtendsCheck(val[i], base[i], narrow));
   }
 }
 var ifTypeOf = (val) => ({
@@ -421,13 +410,6 @@ function isFunction(input) {
   return typeof input === "function";
 }
 
-// src/utility/runtime/conditions/isLiteral.ts
-function isLiteral(...allowed) {
-  return (i) => {
-    return !allowed.every((v) => i !== v);
-  };
-}
-
 // src/utility/runtime/conditions/isNull.ts
 function isNull(i) {
   return i === null;
@@ -538,7 +520,9 @@ function isType(t) {
 function type(fn) {
   const result = fn(typeApi());
   if (!isType(result)) {
-    throw new Error(`When using type(), the callback passed in returned an invalid type! Value returned was: ${result}`);
+    throw new Error(
+      `When using type(), the callback passed in returned an invalid type! Value returned was: ${result}`
+    );
   }
   return result;
 }
@@ -547,16 +531,17 @@ function type(fn) {
 function withValue(td) {
   return (obj) => {
     const t = type(td);
-    return Object.fromEntries([...entries(obj)].filter(([_key, value]) => {
-      return t.typeGuard(value);
-    }));
+    return Object.fromEntries(
+      [...entries(obj)].filter(([_key, value]) => {
+        return t.typeGuard(value);
+      })
+    );
   };
 }
 export {
   Configurator,
   ExplicitFunction,
   FluentConfigurator,
-  KeyStorage,
   Model,
   MutationIdentity,
   and,
@@ -566,6 +551,7 @@ export {
   condition,
   createFnWithProps,
   createMutationFunction,
+  defineProperties,
   defineType,
   dictToKv,
   dictionaryTransform,
@@ -583,7 +569,6 @@ export {
   isBoolean,
   isFalse,
   isFunction,
-  isLiteral,
   isNull,
   isNumber,
   isObject,
@@ -609,6 +594,5 @@ export {
   typeApi,
   uuid,
   valueTypes,
-  valuesOfProp,
   withValue
 };

package/package.json

@@ -1,54 +1,66 @@
 {
   "name": "inferred-types",
-  "version": "0.20.0",
+  "version": "0.22.5",
   "description": "Functions which provide useful type inference on TS projects",
   "license": "MIT",
   "author": "Ken Snyder<ken@ken.net>",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "repository": {
+    "url": "https://github.com/inocan-group/inferred-types"
+  },
   "sideEffects": false,
   "scripts": {
     "about": "tokei src",
     "autoindex": "npx dd autoindex",
     "build": "run-s clean autoindex lint build:bundle",
     "build:force": "run-s clean autoindex build:bundle",
-    "build:bundle": "npx tsup src/index.ts --dts --format='esm,cjs'",
+    "build:bundle": "npx tsup src/index.ts --dts --format=esm,cjs --clean",
     "watch": "run-p watch:*",
     "watch:autoindex": "npx dd autoindex --watch",
-    "watch:bundle": "npx tsup src/index.ts --dts --format='esm,cjs' --watch",
+    "watch:bundle": "npx tsup src/index.ts --dts --format=esm,cjs --watch",
     "clean": "rimraf dist/**/*",
     "lint": "eslint src/**/*.ts --fix && tsc --noEmit ",
     "lint:full": "eslint src/**/*.ts && eslint test/**/*.ts && tsc --noEmit",
-    "test": "jest"
+    "test": "vitest",
+    "test:ci": "vitest run",
+    "audit:fix": "pnpm audit --fix",
+    "release": "run-s lint release:latest test:ci audit:fix release:bump",
+    "release:latest": "pnpm install",
+    "release:bump": "bumpp"
   },
   "devDependencies": {
     "@type-challenges/utils": "~0.1.1",
-    "@types/jest": "^27.4.0",
-    "@types/node": "^14.18.5",
-    "@typescript-eslint/eslint-plugin": "^5.9.1",
-    "@typescript-eslint/parser": "^5.9.1",
-    "common-types": "^1.30.0",
+    "@types/node": "16",
+    "@typescript-eslint/eslint-plugin": "^5.40.1",
+    "@typescript-eslint/parser": "^5.40.1",
+    "bumpp": "^8.2.1",
+    "common-types": "^1.31.1",
     "cross-env": "^7.0.3",
-    "dd": "^0.18.0",
-    "dotenv": "^10.0.0",
-    "eslint": "^8.6.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "eslint-plugin-unicorn": "^40.0.0",
-    "jest": "^27.4.7",
-    "jest-extended": "~1.2.0",
+    "dd": "^0.24.0",
+    "dotenv": "^16.0.3",
+    "eslint": "^8.25.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.0",
     "npm-run-all": "~4.1.5",
-    "prettier": "~2.5.1",
+    "prettier": "~2.7.1",
     "rimraf": "^3.0.2",
-    "ts-jest": "^27.1.2",
-    "ts-node": "^10.4.0",
-    "tsup": "^5.11.11",
-    "typescript": "^4.5.4"
+    "sharp": "^0.31.1",
+    "tsup": "^6.3.0",
+    "typescript": "^4.8.4",
+    "vite": "^3.1.8",
+    "vitest": "^0.24.3"
   },
   "dependencies": {
-    "common-types": "^1.31.0"
+    "brilliant-errors": "^0.6.0"
+  },
+  "pnpm": {
+    "overrides": {
+      "simple-git@<3.3.0": ">=3.3.0",
+      "simple-git@<3.5.0": ">=3.5.0"
+    }
   }
-}
+}

package/src/Mutation/index.ts

@@ -1,37 +1,14 @@
 // #autoindex
 
-// #region autoindexed files
-// index last changed at: 1st Jan, 2022, 03:27 PM ( GMT-8 )
-// hash-code: f6badae2
+// #region auto-indexed files
+// index last changed at: 8th Aug, 2022, 09:51 AM ( GMT-7 )
+// hash-code: bd3a442e
 
 // file exports
 export * from "./MutationFunction";
 export * from "./MutationIdentity";
 
-// #endregion
+// #endregion auto-indexed files
 
-// This file was created by running: "dd autoindex"; it assumes you have
-// the 'do-devops' pkg (that's "dd" on npm) installed as a dev dep.
-//
-// By default it assumes that exports are named exports but this can be changed by
-// adding a modifier to the '// #autoindex' syntax:
-//
-//    - autoindex:named     same as default, exports "named symbols"
-//    - autoindex:default   assumes each file is exporting a default export and
-//                          converts the default export to the name of the file
-//    - autoindex:offset    assumes files export "named symbols" but that each
-//                          file's symbols should be offset by the file's name
-//
-// You may also exclude certain files or directories by adding it to the
-// autoindex command. As an example:
-//
-//    - autoindex:named, exclude: foo,bar,baz
-//
-// Inversely, if you state a file to be an "orphan" then autoindex files
-// below this file will not reference this autoindex file:
-//
-//    - autoindex:named, orphan
-// 
-// All content outside the "// #region" section in this file will be
-// preserved in situations where you need to do something paricularly awesome.
-// Keep on being awesome.
+// see https://github.com/inocan-group/do-devops/docs/autoindex.md
+// for more info