@untool/core - npm Package Compare versions

Comparing version 0.7.0 to 0.8.0

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+<a name="0.8.0"></a>
+# [0.8.0](https://github.com/untool/untool/compare/v0.7.0...v0.8.0) (2018-06-13)
+
+
+### Features
+
+* **core:** add friendly error messages ([0ee61ee](https://github.com/untool/untool/commit/0ee61ee))
+
+
+
+
 <a name="0.7.0"></a>
@@ -8,0 +19,0 @@ # [0.7.0](https://github.com/untool/untool/compare/v0.4.0...v0.7.0) (2018-06-05)

lib/config.js

 const { basename, dirname, join } = require('path');
 
-const { create: { sync: createResolver } } = require('enhanced-resolve');
+const {
+  sync: resolve,
+  create: { sync: createResolver },
+} = require('enhanced-resolve');
 const { sync: findUp } = require('find-up');
@@ -21,58 +24,96 @@ const cosmiconfig = require('cosmiconfig');
 
-const resolvePreset = (context, preset) => {
-  return createResolver({
-    mainFiles: ['preset'],
-    mainFields: ['preset'],
-  })(context, preset);
-};
+const resolvePreset = createResolver({
+  mainFiles: ['preset'],
+  mainFields: ['preset'],
+});
 
-const resolveMixin = (target, context, mixin) => {
+const resolveCoreMixin = createResolver({
+  mainFiles: ['mixin.core', 'mixin'],
+  mainFields: ['mixin:core', 'mixin'],
+});
+
+const resolveServerMixin = createResolver({
+  mainFiles: ['mixin.server', 'mixin.runtime', 'mixin'],
+  mainFields: ['mixin:server', 'mixin:runtime', 'mixin'],
+});
+
+const resolveBrowserMixin = createResolver({
+  mainFiles: ['mixin.browser', 'mixin.runtime', 'mixin'],
+  mainFields: ['mixin:browser', 'mixin:runtime', 'mixin'],
+});
+
+const resolveMixin = (context, mixin, target) => {
   try {
-    const config = {
-      mainFiles: [`mixin.${target}`, 'mixin'],
-      mainFields: [`mixin:${target}`, 'mixin'],
-    };
-    if (target !== 'core') {
-      config.mainFiles.splice(1, 0, 'mixin.runtime');
-      config.mainFields.splice(1, 0, 'mixin:runtime');
+    switch (target) {
+      case 'core':
+        return resolveCoreMixin(context, mixin);
+      case 'server':
+        return resolveServerMixin(context, mixin);
+      case 'browser':
+        return resolveBrowserMixin(context, mixin);
     }
-    return createResolver(config)(context, mixin);
   } catch (_) {
-    return null;
+    return;
   }
 };
 
-const applyEnv = result => {
-  const nsp = process.env.UNTOOL_NSP || 'untool';
-  const env = process.env[nsp.toUpperCase() + '_ENV'] || process.env.NODE_ENV;
-  const config = result && result.config;
-  return result
-    ? {
-        ...result,
-        config: config && config.env ? merge(config, config.env[env]) : config,
+const resolveMixins = (context, mixins) =>
+  mixins.reduce(
+    (result, mixin) => {
+      let found = false;
+      Object.keys(result).forEach((target) => {
+        const targetMixin = resolveMixin(context, mixin, target);
+        if (targetMixin) {
+          if (!result[target].includes(targetMixin)) {
+            result[target].push(targetMixin);
+          }
+          found = true;
+        }
+      });
+      if (!found) {
+        throw new Error(`Can't find mixin '${mixin}'`);
       }
-    : result;
-};
+      return result;
+    },
+    { core: [], server: [], browser: [] }
+  );
 
-const loadConfig = (context, preset) => {
+const loadConfig = (context, config) => {
   const nsp = process.env.UNTOOL_NSP || 'untool';
-  const explorer = cosmiconfig(nsp, { cache: false, stopDir: context });
-  const presetPath = preset && resolvePreset(context, preset);
-  return applyEnv(
-    presetPath ? explorer.loadSync(presetPath) : explorer.searchSync(context)
+  const env = process.env[nsp.toUpperCase() + '_ENV'] || process.env.NODE_ENV;
+  const { loadSync, searchSync } = cosmiconfig(nsp, { stopDir: context });
+  const configPath = config && resolvePreset(context, config);
+  const result = configPath ? loadSync(configPath) : searchSync(context);
+  return (
+    result && {
+      ...result,
+      config:
+        result && result.config && result.config.env
+          ? merge(result.config, result.config.env[env])
+          : result.config,
+    }
   );
 };
 
-const loadSettings = context => {
+const loadSettings = (context) => {
   const result = loadConfig(context);
-  return result ? result.config : {};
+  return {
+    presets: ['@untool/defaults'],
+    ...(result ? result.config : {}),
+  };
 };
 
 const loadPreset = (context, preset) => {
+  const isResolveError = (error) =>
+    error && error.message && error.message.startsWith("Can't resolve");
   try {
     return loadConfig(context, preset);
-  } catch (_) {
-    return loadConfig(
-      dirname(resolvePreset(context, `${preset}/package.json`))
-    );
+  } catch (error) {
+    if (!isResolveError(error)) throw error;
+    try {
+      return loadConfig(dirname(resolve(context, `${preset}/package.json`)));
+    } catch (error) {
+      if (!isResolveError(error)) throw error;
+      throw new Error(`Can't find preset '${preset}' in '${context}'`);
+    }
   }
@@ -84,16 +125,16 @@ };
     const { config, filepath } = loadPreset(context, preset);
-    const newContext = dirname(filepath);
+    const presetContext = dirname(filepath);
     if (config.mixins) {
       config.mixins = config.mixins.map(
-        mixin => (mixin.startsWith('.') ? join(newContext, mixin) : mixin)
+        (mixin) => (mixin.startsWith('.') ? join(presetContext, mixin) : mixin)
       );
     }
-    return merge(configs, loadPresets(newContext, config.presets), config);
+    return merge(configs, loadPresets(presetContext, config.presets), config);
   }, {});
 
-const substitutePlaceholders = config => {
+const substitutePlaceholders = (config) => {
   const flatConfig = flatten(config);
   const keys = Object.keys(flatConfig);
   const regExp = new RegExp(`<(${keys.map(escapeRegExp).join('|')})>`, 'g');
-  const substituteRecursive = item => {
+  const substituteRecursive = (item) => {
     if (Array.isArray(item)) {
@@ -109,3 +150,3 @@ return item.map(substituteRecursive);
     if (typeof item === 'string') {
-      return item.replace(regExp, function(_, match) {
+      return item.replace(regExp, (_, match) => {
         var result = flatConfig[match].toString();
@@ -123,28 +164,16 @@ return regExp.test(result) ? substituteRecursive(result) : result;
   const rootDir = dirname(pkgFile);
-  const {
-    name: namespace = basename(rootDir),
-    version = '0.0.0',
-  } = require(pkgFile);
+  const { name = basename(rootDir), version = '0.0.0' } = require(pkgFile);
 
-  const defaults = { rootDir, namespace, version, mixins: [] };
+  const defaults = { rootDir, name, version, mixins: [] };
   const settings = loadSettings(rootDir);
   const presets = loadPresets(rootDir, settings.presets);
-  const rawConfig = merge(defaults, presets, settings);
+  const config = merge(defaults, presets, settings);
 
-  delete rawConfig.presets;
-  delete rawConfig.env;
+  delete config.presets;
+  delete config.env;
 
-  const config = substitutePlaceholders(rawConfig);
-
-  config.mixins = ['core', 'server', 'browser'].reduce(
-    (result, target) => ({
-      ...result,
-      [target]: config.mixins
-        .map(mixin => resolveMixin(target, config.rootDir, mixin))
-        .filter((mixin, index, self) => mixin && self.indexOf(mixin) === index),
-    }),
-    {}
-  );
-
-  return config;
+  return {
+    ...substitutePlaceholders(config),
+    mixins: resolveMixins(rootDir, config.mixins),
+  };
 };

lib/core.js

@@ -13,3 +13,3 @@ const define = require('mixinable');
   const config = getConfig();
-  const mixins = config.mixins.core.map(mixin => require(mixin));
+  const mixins = config.mixins.core.map((mixin) => require(mixin));
   const strategies = {
@@ -16,0 +16,0 @@ ...mixins.reduce(

lib/runtime.js

@@ -10,3 +10,3 @@ const define = require('mixinable');
 exports.render = function render(...renderArgs) {
-  return config => {
+  return (config) => {
     const { mixins } = config;
@@ -13,0 +13,0 @@ const strategies = mixins.reduce(

package.json

 {
   "name": "@untool/core",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "untool core",
@@ -5,0 +5,0 @@ "main": "lib/core.js",

README.md

@@ -15,3 +15,3 @@ # `@untool/core`
 
-Apart from a couple of very basic properties (`namespace`, `version` and `rootDir`), `@untool/core` does not provide configuration of its own. It does, however, provide an elaborate configuration mechanism.
+Apart from a couple of very basic properties (`name`, `version` and `rootDir`), `@untool/core` does not provide configuration of its own. It does, however, provide an elaborate configuration mechanism.
 
@@ -54,6 +54,6 @@ It allows you to set up mixins and pull in presets. Mixins provide extra functionality. Presets provide configuration defaults and often additionally include custom mixins. Read more about mixins and presets below.
 
-* an `untool` property in your project's `package.json` file
-* an `.untoolrc` file in your project's root folder (JSON, YAML, or JS)
-* an `.untoolrc.{json,yaml,yml,js}` file in your project's root folder
-* an `untool.config.js` file in your project's root folder
+- an `untool` property in your project's `package.json` file
+- an `.untoolrc` file in your project's root folder (JSON, YAML, or JS)
+- an `.untoolrc.{json,yaml,yml,js}` file in your project's root folder
+- an `untool.config.js` file in your project's root folder
 
@@ -101,4 +101,4 @@ We strongly encourage organizing and publishing reusable bits of configuration as custom presets. You can even use any other `untool` project as a preset: just install it (e.g. `yarn add <git remote url>`) and add it to the `presets` section in your project's `untool` configuration.
 
-* a file defined in the `preset` property in the preset's `package.json` file
-* a `preset.js` file in the preset package's root folder
+- a file defined in the `preset` property in the preset's `package.json` file
+- a `preset.js` file in the preset package's root folder
 
@@ -115,8 +115,8 @@ If you want to not only override and extend config values, but rather provide actual features, you can include custom mixins directly in your preset. Some of `untool`'s default presets do just that.
 
-* a file defined in the `mixin:{core,server,browser}` property in the preset's `package.json` file
-* a file defined in the `mixin:runtime` property in the preset's `package.json` file (for `server`+`browser`)
-* a file defined in the `mixin` property in the preset's `package.json` file (for `core`+`server`+`browser`)
-* a `mixin.{core,server,browser}.js` file in the preset package's root folder
-* a `mixin.runtime.js` file in the preset package's root folder (for `server`+`browser`)
-* a `mixin.js` file in the preset package's root folder (for `core`+`server`+`browser`)
+- a file defined in the `mixin:{core,server,browser}` property in the preset's `package.json` file
+- a file defined in the `mixin:runtime` property in the preset's `package.json` file (for `server`+`browser`)
+- a file defined in the `mixin` property in the preset's `package.json` file (for `core`+`server`+`browser`)
+- a `mixin.{core,server,browser}.js` file in the preset package's root folder
+- a `mixin.runtime.js` file in the preset package's root folder (for `server`+`browser`)
+- a `mixin.js` file in the preset package's root folder (for `core`+`server`+`browser`)
 
@@ -123,0 +123,0 @@ By using this mechanism, you can use a single NPM module to provide all three types of mixins, one mixin each for build and runtime or even a single mixin used for all contexts.

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17223

6.82%

Lines of code

194

16.87%

Number of low supply chain risk alerts

5

-16.67%

Number of medium supply chain risk alerts

0

-100%

No dependency changes