npm-update-package 0.31.2 → 0.31.3

package/dist/src/ncu/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Ncu"), exports);

package/dist/src/options/CLIOption.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/options/OptionType.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOptionType = exports.OptionType = void 0;
+exports.OptionType = {
+    String: 'string',
+    StringArray: 'string[]'
+};
+const optionTypes = Object.values(exports.OptionType);
+const isOptionType = (value) => optionTypes.includes(value);
+exports.isOptionType = isOptionType;

package/dist/src/options/Options.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOptions = void 0;
+const io_ts_1 = require("io-ts");
+const logger_1 = require("../logger");
+const package_manager_1 = require("../package-manager");
+const Options = (0, io_ts_1.intersection)([
+    (0, io_ts_1.type)({
+        commitMessage: io_ts_1.string,
+        githubToken: io_ts_1.string,
+        logLevel: (0, io_ts_1.union)([
+            (0, io_ts_1.literal)(logger_1.LogLevel.Off),
+            (0, io_ts_1.literal)(logger_1.LogLevel.Fatal),
+            (0, io_ts_1.literal)(logger_1.LogLevel.Error),
+            (0, io_ts_1.literal)(logger_1.LogLevel.Warn),
+            (0, io_ts_1.literal)(logger_1.LogLevel.Info),
+            (0, io_ts_1.literal)(logger_1.LogLevel.Debug),
+            (0, io_ts_1.literal)(logger_1.LogLevel.Trace)
+        ]),
+        packageManager: (0, io_ts_1.union)([
+            (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Npm),
+            (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Yarn)
+        ]),
+        pullRequestTitle: io_ts_1.string
+    }),
+    (0, io_ts_1.partial)({
+        reviewers: (0, io_ts_1.array)(io_ts_1.string)
+    })
+]);
+exports.isOptions = Options.is;

package/dist/src/options/cliOptions.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cliOptions = void 0;
+const logger_1 = require("../logger");
+const package_manager_1 = require("../package-manager");
+const OptionType_1 = require("./OptionType");
+exports.cliOptions = [
+    {
+        name: 'commit-message',
+        description: 'Commit message template',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        default: 'chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}'
+    },
+    {
+        name: 'github-token',
+        description: 'GitHub token',
+        type: OptionType_1.OptionType.String,
+        required: true
+    },
+    {
+        name: 'log-level',
+        description: 'Log level to show',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        choices: [
+            logger_1.LogLevel.Off,
+            logger_1.LogLevel.Fatal,
+            logger_1.LogLevel.Error,
+            logger_1.LogLevel.Warn,
+            logger_1.LogLevel.Info,
+            logger_1.LogLevel.Debug,
+            logger_1.LogLevel.Trace
+        ],
+        default: logger_1.LogLevel.Info
+    },
+    {
+        name: 'package-manager',
+        description: 'Package manager of your project',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        choices: [
+            package_manager_1.PackageManagerName.Npm,
+            package_manager_1.PackageManagerName.Yarn
+        ],
+        default: package_manager_1.PackageManagerName.Npm
+    },
+    {
+        name: 'pull-request-title',
+        description: 'Pull request title template',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        default: 'chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}'
+    },
+    {
+        name: 'reviewers',
+        description: 'User names to request reviews',
+        type: OptionType_1.OptionType.StringArray,
+        required: false
+    }
+];

package/dist/src/options/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./initOptions"), exports);
+__exportStar(require("./Options"), exports);

package/dist/src/options/initOptions.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initOptions = void 0;
+const commander_1 = require("commander");
+const package_json_1 = __importDefault(require("../../package.json"));
+const cliOptions_1 = require("./cliOptions");
+const Options_1 = require("./Options");
+const toCommanderOption_1 = require("./toCommanderOption");
+// TODO: add test
+const initOptions = () => {
+    commander_1.program.version(package_json_1.default.version);
+    cliOptions_1.cliOptions
+        .map(toCommanderOption_1.toCommanderOption)
+        .forEach(option => commander_1.program.addOption(option));
+    commander_1.program.parse(process.argv);
+    const options = commander_1.program.opts();
+    if (!(0, Options_1.isOptions)(options)) {
+        throw new Error(`Failed to parse command-line options. options=${JSON.stringify(options)}`);
+    }
+    return options;
+};
+exports.initOptions = initOptions;

package/dist/src/options/toCommanderOption.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCommanderOption = void 0;
+const commander_1 = require("commander");
+const OptionType_1 = require("./OptionType");
+// TODO: add test
+const toCommanderOption = (cliOption) => {
+    const argument = createArgumentString(cliOption);
+    const option = new commander_1.Option(`--${cliOption.name} ${argument}`, cliOption.description);
+    if (cliOption.choices !== undefined) {
+        option.choices(cliOption.choices);
+    }
+    if (!cliOption.required && cliOption.default !== undefined) {
+        option.default(cliOption.default);
+    }
+    return option;
+};
+exports.toCommanderOption = toCommanderOption;
+const createArgumentString = (cliOption) => {
+    const prefix = cliOption.required ? '<' : '[';
+    const suffix = cliOption.required ? '>' : ']';
+    const name = createArgumentNameString(cliOption.type);
+    return `${prefix}${name}${suffix}`;
+};
+const createArgumentNameString = (optionType) => {
+    switch (optionType) {
+        case OptionType_1.OptionType.String:
+            return 'value';
+        case OptionType_1.OptionType.StringArray:
+            return 'values...';
+    }
+};

package/dist/src/package-json/PackageMetadata.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPackageMetadata = void 0;
+const io_ts_1 = require("io-ts");
+const PackageMetadataDependencies_1 = require("./PackageMetadataDependencies");
+const PackageMetadata = (0, io_ts_1.intersection)([
+    (0, io_ts_1.type)({
+        name: io_ts_1.string,
+        version: io_ts_1.string
+    }),
+    (0, io_ts_1.partial)({
+        dependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
+        devDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
+        peerDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
+        optionalDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies
+    })
+]);
+exports.isPackageMetadata = PackageMetadata.is;

package/dist/src/package-json/PackageMetadataDependencies.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPackageMetadataDependencies = exports.PackageMetadataDependencies = void 0;
+const io_ts_1 = require("io-ts");
+exports.PackageMetadataDependencies = (0, io_ts_1.record)(io_ts_1.string, io_ts_1.string);
+exports.isPackageMetadataDependencies = exports.PackageMetadataDependencies.is;

package/dist/src/package-json/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./PackageMetadata"), exports);
+__exportStar(require("./parsePackageJson"), exports);

package/dist/src/package-json/parsePackageJson.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePackageJson = void 0;
+const PackageMetadata_1 = require("./PackageMetadata");
+// TODO: add test
+const parsePackageJson = (json) => {
+    const parsed = JSON.parse(json);
+    if ((0, PackageMetadata_1.isPackageMetadata)(parsed)) {
+        return parsed;
+    }
+    else {
+        throw new Error(`Failed to parse package.json. json=${json}`);
+    }
+};
+exports.parsePackageJson = parsePackageJson;

package/dist/src/package-manager/Npm.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Npm = void 0;
+// TODO: add test
+class Npm {
+    constructor(terminal) {
+        this.terminal = terminal;
+        this.packageFile = 'package.json';
+        this.lockFile = 'package-lock.json';
+    }
+    /**
+     * @see https://docs.npmjs.com/cli/v8/commands/npm-install
+     */
+    async install() {
+        await this.terminal.run('npm', 'install');
+    }
+}
+exports.Npm = Npm;

package/dist/src/package-manager/PackageManager.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/package-manager/PackageManagerName.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPackageManagerName = exports.PackageManagerName = void 0;
+exports.PackageManagerName = {
+    Npm: 'npm',
+    Yarn: 'yarn'
+};
+const packageManagerNames = Object.values(exports.PackageManagerName);
+const isPackageManagerName = (value) => packageManagerNames.includes(value);
+exports.isPackageManagerName = isPackageManagerName;

package/dist/src/package-manager/Yarn.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Yarn = void 0;
+// TODO: add test
+class Yarn {
+    constructor(terminal) {
+        this.terminal = terminal;
+        this.packageFile = 'package.json';
+        this.lockFile = 'yarn.lock';
+    }
+    /**
+     * @see https://classic.yarnpkg.com/en/docs/cli/install
+     */
+    async install() {
+        await this.terminal.run('yarn', 'install');
+    }
+}
+exports.Yarn = Yarn;

package/dist/src/package-manager/createPackageManager.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPackageManager = void 0;
+const Npm_1 = require("./Npm");
+const PackageManagerName_1 = require("./PackageManagerName");
+const Yarn_1 = require("./Yarn");
+const createPackageManager = ({ terminal, packageManager }) => {
+    switch (packageManager) {
+        case PackageManagerName_1.PackageManagerName.Npm:
+            return new Npm_1.Npm(terminal);
+        case PackageManagerName_1.PackageManagerName.Yarn:
+            return new Yarn_1.Yarn(terminal);
+    }
+};
+exports.createPackageManager = createPackageManager;

package/dist/src/package-manager/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./createPackageManager"), exports);
+__exportStar(require("./Npm"), exports);
+__exportStar(require("./PackageManager"), exports);
+__exportStar(require("./PackageManagerName"), exports);
+__exportStar(require("./Yarn"), exports);

package/dist/src/semver/SemVer.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SemVer = void 0;
+const semver_1 = require("semver");
+class SemVer {
+    constructor({ version, major, minor, patch }) {
+        this.version = version;
+        this.major = major;
+        this.minor = minor;
+        this.patch = patch;
+    }
+    static of(version) {
+        const semver = (0, semver_1.coerce)(version);
+        if (semver === null) {
+            throw new Error(`Failed to parse version. version=${version}`);
+        }
+        return new SemVer({
+            version: semver.version,
+            major: semver.major,
+            minor: semver.minor,
+            patch: semver.patch
+        });
+    }
+}
+exports.SemVer = SemVer;

package/dist/src/semver/SemVerLevel.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSemVerLevel = exports.SemVerLevel = void 0;
+exports.SemVerLevel = {
+    Major: 'major',
+    Minor: 'minor',
+    Patch: 'patch'
+};
+const semVerLevels = Object.values(exports.SemVerLevel);
+const isSemVerLevel = (value) => semVerLevels.includes(value);
+exports.isSemVerLevel = isSemVerLevel;

package/dist/src/semver/compareSemVers.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareSemVers = void 0;
+const SemVerLevel_1 = require("./SemVerLevel");
+const compareSemVers = (version1, version2) => {
+    if (version1.major !== version2.major) {
+        return SemVerLevel_1.SemVerLevel.Major;
+    }
+    if (version1.minor !== version2.minor) {
+        return SemVerLevel_1.SemVerLevel.Minor;
+    }
+    if (version1.patch !== version2.patch) {
+        return SemVerLevel_1.SemVerLevel.Patch;
+    }
+};
+exports.compareSemVers = compareSemVers;

package/dist/src/semver/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./compareSemVers"), exports);
+__exportStar(require("./SemVer"), exports);
+__exportStar(require("./SemVerLevel"), exports);

package/dist/src/terminal/Terminal.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Terminal = void 0;
+const execa_1 = __importDefault(require("execa"));
+// TODO: add test
+class Terminal {
+    async run(command, ...args) {
+        return await (0, execa_1.default)(command, args);
+    }
+}
+exports.Terminal = Terminal;

package/dist/src/terminal/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Terminal"), exports);

package/jest.config.ts

@@ -0,0 +1,12 @@
+import type { Config } from '@jest/types'
+
+const config: Config.InitialOptions = {
+  preset: 'ts-jest',
+  collectCoverage: true,
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/index.ts'
+  ]
+}
+
+export default config

package/lint-staged.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  '*.js': 'eslint',
+  '*.ts': 'eslint'
+}

package/npm-update-package.code-workspace

@@ -0,0 +1,10 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {
+		"typescript.tsdk": "node_modules/typescript/lib"
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.31.2",
+  "version": "0.31.3",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -12,9 +12,6 @@
     "start": "ts-node src/bin.ts",
     "test": "jest --passWithNoTests"
   },
-  "files": [
-    "/dist"
-  ],
   "bin": "dist/src/bin.js",
   "dependencies": {
     "@octokit/rest": "18.12.0",

package/src/bin.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+import pkg from '../package.json'
+import { createLogger } from './logger'
+import { main } from './main'
+import { initOptions } from './options'
+
+const options = initOptions()
+const logger = createLogger(options.logLevel)
+logger.info(`Start ${pkg.name} v${pkg.version}`)
+
+main({
+  options,
+  logger
+})
+  .then(() => {
+    logger.info(`End ${pkg.name} v${pkg.version}`)
+  })
+  .catch((error: unknown) => {
+    logger.fatal(error)
+    throw error
+  })

package/src/core/FailedResult.ts

@@ -0,0 +1,6 @@
+import type { OutdatedPackage } from './OutdatedPackage'
+
+export interface FailedResult {
+  outdatedPackage: OutdatedPackage
+  error: unknown
+}

package/src/core/OutdatedPackage.ts

@@ -0,0 +1,11 @@
+import type {
+  SemVer,
+  SemVerLevel
+} from '../semver'
+
+export interface OutdatedPackage {
+  name: string
+  currentVersion: SemVer
+  newVersion: SemVer
+  level: SemVerLevel
+}