nodemon-sudo 0.0.1-security → 3.1.16

package/doc/cli/options.txt

@@ -0,0 +1,36 @@
+
+Configuration
+  --config <file> .......... alternate nodemon.json config file to use
+  --exitcrash .............. exit on crash, allows nodemon to work with other watchers
+  -i, --ignore ............. ignore specific files or directories
+  --no-colors .............. disable color output
+  --signal <signal> ........ use specified kill signal instead of default (ex. SIGTERM)
+  -w, --watch path ......... watch directory "dir" or files. use once for each
+                             directory or file to watch
+  --no-update-notifier ..... opt-out of update version check
+
+Execution
+  -C, --on-change-only ..... execute script on change only, not startup
+  --cwd <dir> .............. change into <dir> before running the script
+  -e, --ext ................ extensions to look for, ie. "js,pug,hbs"
+  -I, --no-stdin ........... nodemon passes stdin directly to child process
+  --spawn .................. force nodemon to use spawn (over fork) [node only]
+  -x, --exec app ........... execute script with "app", ie. -x "python -v"
+  -- <your args> ........... to tell nodemon stop slurping arguments
+
+Watching
+  -d, --delay n ............ debounce restart for "n" seconds
+  -L, --legacy-watch ....... use polling to watch for changes (typically needed
+                             when watching over a network/Docker)
+  -P, --polling-interval ... combined with -L, milliseconds to poll for (default 100)
+
+Information
+  --dump ................... print full debug configuration
+  -h, --help ............... default help
+  --help <topic> ........... help on a specific feature. Try "--help topics"
+  -q, --quiet .............. minimise nodemon messages to start/stop only
+  -v, --version ............ current nodemon version
+  -V, --verbose ............ show detail on what is causing restarts
+
+
+> Note that any unrecognised arguments are passed to the executing command.

package/doc/cli/topics.txt

@@ -0,0 +1,8 @@
+
+  options .................. show all available nodemon options
+  config ................... default config options using nodemon.json
+  authors .................. contributors to this project
+  logo ..................... <3
+  whoami ................... I, AM, NODEMON \o/
+
+  Please support https://github.com/remy/nodemon/

package/doc/cli/usage.txt

@@ -0,0 +1,3 @@
+  Usage: nodemon [nodemon options] [script.js] [args]
+
+  See "nodemon --help" for more.

package/doc/cli/whoami.txt

@@ -0,0 +1,9 @@
+__/\\\\\_____/\\\_______/\\\\\_______/\\\\\\\\\\\\_____/\\\\\\\\\\\\\\\__/\\\\____________/\\\\_______/\\\\\_______/\\\\\_____/\\\_
+ _\/\\\\\\___\/\\\_____/\\\///\\\____\/\\\////////\\\__\/\\\///////////__\/\\\\\\________/\\\\\\_____/\\\///\\\____\/\\\\\\___\/\\\_
+  _\/\\\/\\\__\/\\\___/\\\/__\///\\\__\/\\\______\//\\\_\/\\\_____________\/\\\//\\\____/\\\//\\\___/\\\/__\///\\\__\/\\\/\\\__\/\\\_
+   _\/\\\//\\\_\/\\\__/\\\______\//\\\_\/\\\_______\/\\\_\/\\\\\\\\\\\_____\/\\\\///\\\/\\\/_\/\\\__/\\\______\//\\\_\/\\\//\\\_\/\\\_
+    _\/\\\\//\\\\/\\\_\/\\\_______\/\\\_\/\\\_______\/\\\_\/\\\///////______\/\\\__\///\\\/___\/\\\_\/\\\_______\/\\\_\/\\\\//\\\\/\\\_
+     _\/\\\_\//\\\/\\\_\//\\\______/\\\__\/\\\_______\/\\\_\/\\\_____________\/\\\____\///_____\/\\\_\//\\\______/\\\__\/\\\_\//\\\/\\\_
+      _\/\\\__\//\\\\\\__\///\\\__/\\\____\/\\\_______/\\\__\/\\\_____________\/\\\_____________\/\\\__\///\\\__/\\\____\/\\\__\//\\\\\\_
+       _\/\\\___\//\\\\\____\///\\\\\/_____\/\\\\\\\\\\\\/___\/\\\\\\\\\\\\\\\_\/\\\_____________\/\\\____\///\\\\\/_____\/\\\___\//\\\\\_
+        _\///_____\/////_______\/////_______\////////////_____\///////////////__\///______________\///_______\/////_______\///_____\/////__

package/index.d.ts

@@ -0,0 +1,124 @@
+import type { WatchOptions } from 'chokidar';
+
+export type NodemonEventHandler =
+  | 'start'
+  | 'crash'
+  | 'exit'
+  | 'quit'
+  | 'restart'
+  | 'config:update'
+  | 'log'
+  | 'readable'
+  | 'stdout'
+  | 'stderr';
+
+export type NodemonEventListener = {
+  on(event: 'start' | 'crash' | 'readable', listener: () => void): Nodemon;
+  on(event: 'log', listener: (e: NodemonEventLog) => void): Nodemon;
+  on(event: 'stdout' | 'stderr', listener: (e: string) => void): Nodemon;
+  on(event: 'restart', listener: (files?: string[]) => void): Nodemon;
+  on(event: 'quit', listener: (e?: NodemonEventQuit) => void): Nodemon;
+  on(event: 'exit', listener: (e?: number) => void): Nodemon;
+  on(
+    event: 'config:update',
+    listener: (e?: NodemonEventConfig) => void,
+  ): Nodemon;
+};
+
+export type NodemonEventLog = {
+  /**
+    - detail: what you get with nodemon --verbose.
+    - status: subprocess starting, restarting.
+    - fail: is the subprocess crashing.
+    - error: is a nodemon system error.
+  */
+  type: 'detail' | 'log' | 'status' | 'error' | 'fail';
+  /** the plain text message */
+  message: string;
+  /** contains the terminal escape codes to add colour, plus the "[nodemon]" prefix */
+  colour: string;
+};
+
+export type NodemonEventQuit = 143 | 130;
+
+export type NodemonEventConfig = {
+  run: boolean;
+  system: {
+    cwd: string;
+  };
+  required: boolean;
+  dirs: string[];
+  timeout: number;
+  options: NodemonConfig;
+  lastStarted: number;
+  loaded: string[];
+  load: (
+    settings: NodemonSettings,
+    ready: (config: NodemonEventConfig) => void,
+  ) => void;
+  reset: () => void;
+};
+
+export interface NodemonExecOptions {
+  script: string;
+  scriptPosition?: number;
+  args?: string[];
+  ext?: string; // "js,mjs" etc (should really support an array of strings, but I don't think it does right now)
+  exec?: string; // node, python, etc
+  execArgs?: string[]; // args passed to node, etc,
+  nodeArgs?: string[]; // args passed to node, etc,
+}
+
+export interface NodemonConfig {
+  /** restartable defaults to "rs" as a string the user enters */
+  restartable?: false | string;
+  colours?: boolean;
+  execMap?: { [key: string]: string };
+  ignoreRoot?: string[];
+  watch?: string[];
+  ignore?: string[];
+  stdin?: boolean;
+  runOnChangeOnly?: boolean;
+  verbose?: boolean;
+  signal?: string;
+  stdout?: boolean;
+  watchOptions?: WatchOptions;
+  help?: string;
+  version?: boolean;
+  cwd?: string;
+  dump?: boolean;
+  delay?: number;
+  monitor?: string[];
+  spawn?: boolean;
+  noUpdateNotifier?: boolean;
+  legacyWatch?: boolean;
+  pollingInterval?: number;
+  /** @deprecated as this is "on" by default */
+  js?: boolean;
+  quiet?: boolean;
+  configFile?: string;
+  exitCrash?: boolean;
+  execOptions?: NodemonExecOptions;
+}
+
+export interface NodemonSettings extends NodemonConfig, NodemonExecOptions {
+  events?: Record<string, string>;
+  env?: Record<string, string>;
+}
+
+export type Nodemon = {
+  (settings: NodemonSettings): Nodemon;
+  removeAllListeners(event: NodemonEventHandler): Nodemon;
+  emit(type: NodemonEventHandler, event?: any): Nodemon;
+  reset(callback: Function): Nodemon;
+  restart(): Nodemon;
+  config: NodemonSettings;
+} & NodemonEventListener & {
+    [K in keyof NodemonEventListener as 'addListener']: NodemonEventListener[K];
+  } & {
+    [K in keyof NodemonEventListener as 'once']: NodemonEventListener[K];
+  };
+
+declare const nodemon: Nodemon;
+
+export = nodemon;

package/jsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "typeRoots": ["./index.d.ts", "./node_modules/@types"],
+    "checkJs": true
+  },
+  "exclude": ["node_modules"]
+}

package/lib/cli/index.js

@@ -0,0 +1,49 @@
+var parse = require('./parse');
+
+/**
+ * Converts a string to command line args, in particular
+ * groups together quoted values.
+ * This is a utility function to allow calling nodemon as a required
+ * library, but with the CLI args passed in (instead of an object).
+ *
+ * @param  {String} string
+ * @return {Array}
+ */
+function stringToArgs(string) {
+  var args = [];
+
+  var parts = string.split(' ');
+  var length = parts.length;
+  var i = 0;
+  var open = false;
+  var grouped = '';
+  var lead = '';
+
+  for (; i < length; i++) {
+    lead = parts[i].substring(0, 1);
+    if (lead === '"' || lead === '\'') {
+      open = lead;
+      grouped = parts[i].substring(1);
+    } else if (open && parts[i].slice(-1) === open) {
+      open = false;
+      grouped += ' ' + parts[i].slice(0, -1);
+      args.push(grouped);
+    } else if (open) {
+      grouped += ' ' + parts[i];
+    } else {
+      args.push(parts[i]);
+    }
+  }
+
+  return args;
+}
+
+module.exports = {
+  parse: function (argv) {
+    if (typeof argv === 'string') {
+      argv = stringToArgs(argv);
+    }
+
+    return parse(argv);
+  },
+};

package/lib/cli/parse.js

@@ -0,0 +1,230 @@
+/*
+
+nodemon is a utility for node, and replaces the use of the executable
+node. So the user calls `nodemon foo.js` instead.
+
+nodemon can be run in a number of ways:
+
+`nodemon` - tries to use package.json#main property to run
+`nodemon` - if no package, looks for index.js
+`nodemon app.js` - runs app.js
+`nodemon --arg app.js --apparg` - eats arg1, and runs app.js with apparg
+`nodemon --apparg` - as above, but passes apparg to package.json#main (or
+  index.js)
+`nodemon --debug app.js
+
+*/
+
+var fs = require('fs');
+var path = require('path');
+var existsSync = fs.existsSync || path.existsSync;
+
+module.exports = parse;
+
+/**
+ * Parses the command line arguments `process.argv` and returns the
+ * nodemon options, the user script and the executable script.
+ *
+ * @param  {Array<string> | string} argv full process arguments, including `node` leading arg
+ * @return {Object} { options, script, args }
+ */
+function parse(argv) {
+  if (typeof argv === 'string') {
+    argv = argv.split(' ');
+  }
+
+  var eat = function (i, args) {
+    if (i <= args.length) {
+      return args.splice(i + 1, 1).pop();
+    }
+  };
+
+  var args = argv.slice(2);
+  var script = null;
+  var nodemonOptions = { scriptPosition: null };
+
+  var nodemonOpt = nodemonOption.bind(null, nodemonOptions);
+  var lookForArgs = true;
+
+  // move forward through the arguments
+  for (var i = 0; i < args.length; i++) {
+    // if the argument looks like a file, then stop eating
+    if (!script) {
+      if (args[i] === '.' || existsSync(args[i])) {
+        script = args.splice(i, 1).pop();
+
+        // we capture the position of the script because we'll reinsert it in
+        // the right place in run.js:command (though I'm not sure we should even
+        // take it out of the array in the first place, but this solves passing
+        // arguments to the exec process for now).
+        nodemonOptions.scriptPosition = i;
+        i--;
+        continue;
+      }
+    }
+
+    if (lookForArgs) {
+      // respect the standard way of saying: hereafter belongs to my script
+      if (args[i] === '--') {
+        args.splice(i, 1);
+        nodemonOptions.scriptPosition = i;
+        // cycle back one argument, as we just ate this one up
+        i--;
+
+        // ignore all further nodemon arguments
+        lookForArgs = false;
+
+        // move to the next iteration
+        continue;
+      }
+
+      if (nodemonOpt(args[i], eat.bind(null, i, args)) !== false) {
+        args.splice(i, 1);
+        // cycle back one argument, as we just ate this one up
+        i--;
+      }
+    }
+  }
+
+  nodemonOptions.script = script;
+  nodemonOptions.args = args;
+
+  return nodemonOptions;
+}
+
+
+/**
+ * Given an argument (ie. from process.argv), sets nodemon
+ * options and can eat up the argument value
+ *
+ * @param {import('../..').NodemonSettings} options object that will be updated
+ * @param {String} arg current argument from argv
+ * @param {Function} eatNext the callback to eat up the next argument in argv
+ * @return {Boolean} false if argument was not a nodemon arg
+ */
+function nodemonOption(options, arg, eatNext) {
+  // line separation on purpose to help legibility
+  if (arg === '--help' || arg === '-h' || arg === '-?') {
+    var help = eatNext();
+    options.help = help ? help : true;
+  } else
+
+  if (arg === '--version' || arg === '-v') {
+    options.version = true;
+  } else
+
+  if (arg === '--no-update-notifier') {
+    options.noUpdateNotifier = true;
+  } else
+
+  if (arg === '--spawn') {
+    options.spawn = true;
+  } else
+
+  if (arg === '--dump') {
+    options.dump = true;
+  } else
+
+  if (arg === '--verbose' || arg === '-V') {
+    options.verbose = true;
+  } else
+
+  if (arg === '--legacy-watch' || arg === '-L') {
+    options.legacyWatch = true;
+  } else
+
+  if (arg === '--polling-interval' || arg === '-P') {
+    options.pollingInterval = parseInt(eatNext(), 10);
+  } else
+
+  // Depricated as this is "on" by default
+  if (arg === '--js') {
+    options.js = true;
+  } else
+
+  if (arg === '--quiet' || arg === '-q') {
+    options.quiet = true;
+  } else
+
+  if (arg === '--config') {
+    options.configFile = eatNext();
+  } else
+
+  if (arg === '--watch' || arg === '-w') {
+    if (!options.watch) { options.watch = []; }
+    options.watch.push(eatNext());
+  } else
+
+  if (arg === '--ignore' || arg === '-i') {
+    if (!options.ignore) { options.ignore = []; }
+    options.ignore.push(eatNext());
+  } else
+
+  if (arg === '--exitcrash') {
+    options.exitCrash = true;
+  } else
+
+  if (arg === '--delay' || arg === '-d') {
+    options.delay = parseDelay(eatNext());
+  } else
+
+  if (arg === '--exec' || arg === '-x') {
+    options.exec = eatNext();
+  } else
+
+  if (arg === '--no-stdin' || arg === '-I') {
+    options.stdin = false;
+  } else
+
+  if (arg === '--on-change-only' || arg === '-C') {
+    options.runOnChangeOnly = true;
+  } else
+
+  if (arg === '--ext' || arg === '-e') {
+    options.ext = eatNext();
+  } else
+
+  if (arg === '--no-colours' || arg === '--no-colors') {
+    options.colours = false;
+  } else
+
+  if (arg === '--signal' || arg === '-s') {
+    options.signal = eatNext();
+  } else
+
+  if (arg === '--cwd') {
+    options.cwd = eatNext();
+
+    // go ahead and change directory. This is primarily for nodemon tools like
+    // grunt-nodemon - we're doing this early because it will affect where the
+    // user script is searched for.
+    process.chdir(path.resolve(options.cwd));
+  } else {
+
+    // this means we didn't match
+    return false;
+  }
+}
+
+/**
+ * Given an argument (ie. from nodemonOption()), will parse and return the
+ * equivalent millisecond value or 0 if the argument cannot be parsed
+ *
+ * @param {String} value argument value given to the --delay option
+ * @return {Number} millisecond equivalent of the argument
+ */
+function parseDelay(value) {
+  var millisPerSecond = 1000;
+  var millis = 0;
+
+  if (value.match(/^\d*ms$/)) {
+    // Explicitly parse for milliseconds when using ms time specifier
+    millis = parseInt(value, 10);
+  } else {
+    // Otherwise, parse for seconds, with or without time specifier then convert
+    millis = parseFloat(value) * millisPerSecond;
+  }
+
+  return isNaN(millis) ? 0 : millis;
+}
+

package/lib/config/command.js

@@ -0,0 +1,43 @@
+module.exports = command;
+
+/**
+ * command constructs the executable command to run in a shell including the
+ * user script, the command arguments.
+ *
+ * @param  {Object} settings Object as:
+ *                           { execOptions: {
+ *                               exec: String,
+ *                               [script: String],
+ *                               [scriptPosition: Number],
+ *                               [execArgs: Array<string>]
+ *                             }
+ *                           }
+ * @return {Object}          an object with the node executable and the
+ *                           arguments to the command
+ */
+function command(settings) {
+  var options = settings.execOptions;
+  var executable = options.exec;
+  var args = [];
+
+  // after "executable" go the exec args (like --debug, etc)
+  if (options.execArgs) {
+    [].push.apply(args, options.execArgs);
+  }
+
+  // then goes the user's script arguments
+  if (options.args) {
+    [].push.apply(args, options.args);
+  }
+
+  // after the "executable" goes the user's script
+  if (options.script) {
+    args.splice((options.scriptPosition || 0) +
+      options.execArgs.length, 0, options.script);
+  }
+
+  return {
+    executable: executable,
+    args: args,
+  };
+}

package/lib/config/defaults.js

@@ -0,0 +1,34 @@
+var ignoreRoot = require('ignore-by-default').directories();
+
+// default options for config.options
+const defaults = {
+  restartable: 'rs',
+  colours: true,
+  execMap: {
+    py: 'python',
+    rb: 'ruby',
+    ts: 'ts-node',
+    // more can be added here such as ls: lsc - but please ensure it's cross
+    // compatible with linux, mac and windows, or make the default.js
+    // dynamically append the `.cmd` for node based utilities
+  },
+  ignoreRoot: ignoreRoot.map((_) => `**/${_}/**`),
+  watch: ['*.*'],
+  stdin: true,
+  runOnChangeOnly: false,
+  verbose: false,
+  signal: 'SIGUSR2',
+  // 'stdout' refers to the default behaviour of a required nodemon's child,
+  // but also includes stderr. If this is false, data is still dispatched via
+  // nodemon.on('stdout/stderr')
+  stdout: true,
+  watchOptions: {},
+};
+
+const nodeOptions = process.env.NODE_OPTIONS || ''; // ?
+
+if (/--(loader|import)\b/.test(nodeOptions)) {
+  delete defaults.execMap.ts;
+}
+
+module.exports = defaults;