cli-engine-config - npm Package Compare versions

Comparing version 4.0.1-ts.5 to 4.0.1-ts.6

lib/config.d.ts

@@ -1,8 +0,4 @@
-import { InputArgs, InputFlags } from 'cli-flags';
 import 'core-js/library';
-export declare type Topic = {
-    name: string;
-    description?: string;
-    hidden?: boolean;
-};
+import { Topic, Plugin, ICommand } from './command';
+export { Topic, Plugin, ICommand };
 export declare type UserConfig = {
@@ -80,28 +76,3 @@ skipAnalytics?: boolean;
 export declare type ConfigOptions = Partial<Config>;
-export interface RunReturn {
-    readonly stdout?: string;
-    readonly stderr?: string;
-}
-export declare type Plugin = {
-    name: string;
-    version: string;
-};
-export interface ICommand {
-    _version: string;
-    topic?: string | undefined;
-    command?: string | undefined;
-    description?: string;
-    hidden: boolean;
-    usage?: string;
-    help?: string;
-    aliases: string[];
-    id: string;
-    buildHelp?: (config: Config) => string;
-    buildHelpLine?: (config: Config) => [string, string | undefined];
-    Args?: InputArgs;
-    Flags?: InputFlags;
-    run: (config?: ConfigOptions) => Promise<RunReturn | void>;
-    plugin?: Plugin;
-}
 export declare function buildConfig(existing?: ConfigOptions): Config;
 export declare const defaultConfig: Config;

lib/config.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+require("core-js/library");
 const fs = require("fs-extra");
 const os = require("os");
 const path = require("path");
-require("core-js/library");
 function dir(config, category, d) {
@@ -125,2 +125,34 @@ let cacheKey = `dir:${category}`;
 }
+// function validatePJSON (pjson: PJSON) {
+// const exampleCLI = {
+//   bin: 'heroku',
+//   dirname: 'heroku',
+//   node: '8.0.0',
+//   defaultCommand: 'dashboard',
+//   commands: './lib/commands',
+//   hooks: {
+//     init: './lib/hooks/init.js',
+//     update: './lib/hooks/update.js',
+//     prerun: './lib/hooks/prerun.js',
+//     'plugins:preinstall': './lib/hooks/plugins/preinstall.js'
+//   },
+//   s3: {host: 'host'},
+//   plugins: ['heroku-pg', 'heroku-redis']
+// }
+// TODO: validate
+// const cli = pjson['cli-engine'] || {}
+// const comment = 'cli-engine-config'
+// const title = {
+//   warning: 'invalid CLI package.json',
+//   error: 'invalid CLI package.json' }
+// validate(cli, {comment, title, exampleConfig: exampleCLI})
+// validate(cli.hooks, {
+//   comment,
+//   condition: (option, validOption) => {
+//     console.dir({option, validOption})
+//   },
+//   title,
+//   exampleConfig: exampleCLI.hooks
+// })
+// }
 function buildConfig(existing = {}) {
@@ -127,0 +159,0 @@ if (!existing)

package.json

 {
   "name": "cli-engine-config",
   "description": "base cli-engine config objects and interfaces",
-  "version": "4.0.1-ts.5",
+  "version": "4.0.1-ts.6",
   "author": "Jeff Dickey @dickeyxxx",
   "bugs": "https://github.com/heroku/cli-engine-config/issues",
   "dependencies": {
-    "cli-flags": "^1.0.6",
-    "fs-extra": "^4.0.1",
+    "cli-flags": "^1.0.7",
+    "fs-extra": "^4.0.2",
     "uuid": "^3.1.0"
@@ -11,0 +11,0 @@ },

No alert changes

Improved metrics

Total package byte prevSize

12084

increased by9.78%

Number of package files

6

increased by50%

Lines of code

341

increased by11.8%

Dependency changes

• Updatedcli-flags@^1.0.7

• Updatedfs-extra@^4.0.2