@qiwi/semrel-plugin-creator - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

CHANGELOG.md

@@ -0,1 +1,22 @@
+# @qiwi/semrel-plugin-creator [2.2.0](https://github.com/qiwi/semantic-release-toolkit/compare/@qiwi/semrel-plugin-creator@2.1.0...@qiwi/semrel-plugin-creator@2.2.0) (2021-11-17)
+
+
+### Bug Fixes
+
+* up deps to fix internal esm-cjs interop ([830ac9d](https://github.com/qiwi/semantic-release-toolkit/commit/830ac9dc86c5bad940628c07d2155524a42be71f))
+
+
+### Features
+
+* add esnext bundle ([d18b30c](https://github.com/qiwi/semantic-release-toolkit/commit/d18b30cff360536b76e403a6a658c2bf75ca5e43))
+
+
+
+
+
+### Dependencies
+
+* **@qiwi/semrel-infra:** upgraded to 3.0.0
+* **@qiwi/semrel-testing-suite:** upgraded to 3.0.0
+
 # @qiwi/semrel-plugin-creator [2.1.0](https://github.com/qiwi/semantic-release-toolkit/compare/@qiwi/semrel-plugin-creator@2.0.0...@qiwi/semrel-plugin-creator@2.1.0) (2021-10-28)
@@ -2,0 +23,0 @@

flow-typed/index.flow.js

@@ -274,1 +274,133 @@ /**
 }
+
+declare module "@qiwi/semrel-plugin-creator/target/esnext" {
+  import type {
+    TPlugin,
+    TPluginConfig,
+    TPluginFactory,
+    TPluginFactoryOptions,
+    TPluginFactoryOptionsNormalized,
+    TReleaseHandler,
+    TReleaseStep,
+    TSemrelContext,
+  } from "@qiwi/semrel-plugin-creator/target/esnext/interface";
+
+  declare export * from "@qiwi/semrel-plugin-creator/target/esnext/interface";
+
+  declare export var releaseSteps: Array<TReleaseStep>;
+  declare export var defaultOptions: {
+    include: $Keys<TPlugin>[],
+    exclude: empty[],
+    require: empty[],
+    handler: () => Promise<void>,
+    ...
+  };
+  declare export var normalizeOptions: (
+    options: TReleaseHandler | TPluginFactoryOptions
+  ) => TPluginFactoryOptionsNormalized;
+  declare export var getStepConfig: (
+    context: TSemrelContext,
+    step: TReleaseStep,
+    name?: string
+  ) => TPluginConfig | void;
+  declare export var getStepConfigs: (
+    context: TSemrelContext,
+    name?: string
+  ) => { [key: TReleaseStep]: TPluginConfig | void, ... };
+  declare export var createPlugin: TPluginFactory;
+}
+
+declare module "@qiwi/semrel-plugin-creator/target/esnext/interface" {
+  import type { Debugger } from "debug";
+
+  import type { Context } from "semantic-release";
+
+  declare export { Debugger } from "debug";
+
+  declare export type TReleaseType = "patch" | "minor" | "major";
+  declare export type TTag = {
+    version: string,
+    channel: string,
+    gitTag: string,
+    gitHead: string,
+    ...
+  };
+  declare export type TBranch = {
+    channel?: string,
+    tags: string[],
+    type: string,
+    name: string,
+    range: string,
+    accept: TReleaseType[],
+    main: boolean,
+    ...
+  };
+  declare export type TSemrelContext = {
+    ...Context,
+    ...{
+      cwd: string,
+      branch?: TBranch,
+      branches: string[],
+      ...
+    },
+  };
+  declare export type TPluginConfig = { [key: any]: any, ... };
+  declare export type TPluginMethod<T = void> = (
+    pluginConfig: TPluginConfig,
+    context: TSemrelContext
+  ) => Promise<T>;
+  declare export interface TPlugin {
+    verifyConditions?: TPluginMethod<>;
+    analyzeCommits?: TPluginMethod<TReleaseType>;
+    verifyRelease?: TPluginMethod<>;
+    generateNotes?: TPluginMethod<string>;
+    prepare?: TPluginMethod<>;
+    publish?: TPluginMethod<>;
+    addChannel?: TPluginMethod<>;
+    success?: TPluginMethod<>;
+    fail?: TPluginMethod<>;
+  }
+  declare export type TReleaseStep = $Keys<TPlugin>;
+  declare export type TStepConfigs = {
+    [key: TReleaseStep]: TPluginConfig | void,
+    ...
+  };
+  declare export type TPluginHandlerContext = {
+    pluginConfig: TPluginConfig,
+    stepConfig?: TPluginConfig,
+    stepConfigs: TStepConfigs,
+    context: TSemrelContext,
+    step: TReleaseStep,
+    debug: Debugger,
+    ...
+  };
+  declare export type TReleaseHandler = (
+    context: TPluginHandlerContext
+  ) => Promise<any>;
+  declare export type TPluginFactoryOptionsNormalized = {
+    handler: TReleaseHandler,
+    name?: string,
+    include: TReleaseStep[],
+    exclude: TReleaseStep[],
+    require: TReleaseStep[],
+    debug: Debugger,
+    ...
+  };
+  declare export type TPluginFactoryOptions = $Rest<
+    {
+      ...Omit<TPluginFactoryOptionsNormalized, "debug">,
+      ...{
+        debug: string | Debugger,
+        ...
+      },
+    },
+    { ... }
+  >;
+  declare export type TPluginFactory = (
+    handler: TPluginFactoryOptions | TReleaseHandler
+  ) => TPlugin;
+  declare export type TPluginMetaContext = {
+    invoked: TReleaseStep[],
+    ...
+  };
+}

package.json

 {
   "name": "@qiwi/semrel-plugin-creator",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "private": false,
@@ -9,13 +9,12 @@ "publishConfig": {
   "description": "Semrel plugin creator",
-  "type": "module",
   "exports": {
-    "import": "./target/exports/es6.mjs",
-    "require": "./target/exports/es5.cjs"
+    ".": {
+      "module": "./target/exports/es6.mjs",
+      "import": "./target/exports/es6.mjs",
+      "require": "./target/exports/es5.cjs"
+    }
   },
-  "main": "target/es6",
-  "source": "target/ts/index.ts",
-  "types": "target/es5/index.d.ts",
-  "typescript": {
-    "definition": "target/es5/index.d.ts"
-  },
+  "module": "./target/exports/es6.mjs",
+  "source": "./target/ts/index.ts",
+  "types": "./target/es6/index.d.ts",
   "keywords": [],
@@ -35,10 +34,12 @@ "files": [
     "test": "npm-run-all -p -l lint test:unit test:depcheck",
-    "test:unit": "jest --config=jest.config.js --runInBand",
-    "test:depcheck": "depcheck --ignores @types/*,tslib,eslint-*,prettier-*,@qiwi/semrel-infra,@qiwi/esm,@qiwi/semrel-plugin-creator --ignore-patterns typings,flow-typed/*",
-    "build": "npm-run-all -p -l build:es5 build:es6 build:exports build:ts build:libdef docs",
+    "test:unit": "NODE_OPTIONS=--experimental-vm-modules jest --config=jest.config.mjs --runInBand",
+    "test:depcheck": "depcheck --ignores @qiwi/esm,@jest/globals,@types/*,tslib,eslint-*,prettier-*,@qiwi/semrel-infra,@qiwi/semrel-plugin-creator --ignore-patterns typings,flow-typed/*",
+    "build": "npm-run-all -p -l build:es5 build:es6 build:exports build:ts build:esnext build:libdef docs && yarn build:esmfix",
+    "build:esnext": "mkdirp target/esnext && tsc -p tsconfig.esnext.json",
     "build:es5": "mkdirp target/es5 && tsc -p tsconfig.es5.json",
     "build:es6": "mkdirp target/es6 && tsc -p tsconfig.es6.json",
     "build:ts": "cpy ./ ../../../target/ts/ --parents --dot --cwd=./src/main/ts/",
+    "build:esmfix": "yarn tsc-esm-fix --target=target/es6 --target=target/esnext --dirnameVar=false --ext=.mjs",
     "build:exports": "cpy src/main/exports/ target/exports/",
-    "build:libdef": "libdefkit --tsconfig=tsconfig.es5.json --tsconfig=tsconfig.es6.json",
+    "build:libdef": "libdefkit --tsconfig=tsconfig.es5.json --tsconfig=tsconfig.es6.json --tsconfig=tsconfig.esnext.json",
     "docs": "typedoc --options ./typedoc.json ./src/main/ts",
@@ -49,6 +50,6 @@ "uglify": "for f in $(find target -name '*.js'); do short=${f%.js}; terser -c -m -o $short.js -- $f; done",
   "dependencies": {
-    "@qiwi/esm": "^1.0.0",
+    "@qiwi/esm": "^1.1.1",
     "tslib": "^2.3.1",
-    "@types/semantic-release": "^17.2.2",
-    "@types/node": "^16.11.6",
+    "@types/semantic-release": "^17.2.3",
+    "@types/node": "^16.11.7",
     "@types/lodash-es": "^4.17.5",
@@ -59,4 +60,4 @@ "lodash-es": "^4.17.21",
   "devDependencies": {
-    "@qiwi/semrel-infra": "2.1.0",
-    "@qiwi/semrel-testing-suite": "2.1.0",
+    "@qiwi/semrel-infra": "3.0.0",
+    "@qiwi/semrel-testing-suite": "3.0.0",
     "semantic-release": "^18.0.0",
@@ -78,3 +79,4 @@ "resolve-from": "^5.0.0",
   "homepage": "https://github.com/qiwi/semantic-release-toolkit/#readme",
-  "prettier": "prettier-config-qiwi"
+  "prettier": "prettier-config-qiwi",
+  "main": "./target/exports/es5.cjs"
 }

typings/index.d.ts

@@ -179,1 +179,88 @@ declare module '@qiwi/semrel-plugin-creator' {
 
+// Generated by dts-bundle v0.7.5
+// Dependencies for this module:
+//   ../../../../../../../debug
+//   ../../../../../../../semantic-release
+
+declare module '@qiwi/semrel-plugin-creator/target/esnext' {
+    import { TPlugin, TPluginConfig, TPluginFactory, TPluginFactoryOptions, TPluginFactoryOptionsNormalized, TReleaseHandler, TReleaseStep, TSemrelContext } from '@qiwi/semrel-plugin-creator/target/esnext/interface';
+    export * from '@qiwi/semrel-plugin-creator/target/esnext/interface';
+    export const releaseSteps: Array<TReleaseStep>;
+    export const defaultOptions: {
+        include: (keyof TPlugin)[];
+        exclude: never[];
+        require: never[];
+        handler: () => Promise<void>;
+    };
+    export const normalizeOptions: (options: TReleaseHandler | TPluginFactoryOptions) => TPluginFactoryOptionsNormalized;
+    export const getStepConfig: (context: TSemrelContext, step: TReleaseStep, name?: string) => TPluginConfig | undefined;
+    export const getStepConfigs: (context: TSemrelContext, name?: string) => Record<TReleaseStep, TPluginConfig | undefined>;
+    export const createPlugin: TPluginFactory;
+}
+
+declare module '@qiwi/semrel-plugin-creator/target/esnext/interface' {
+    import { Debugger } from 'debug';
+    import { Context } from 'semantic-release';
+    export { Debugger } from 'debug';
+    export type TReleaseType = 'patch' | 'minor' | 'major';
+    export type TTag = {
+        version: string;
+        channel: string;
+        gitTag: string;
+        gitHead: string;
+    };
+    export type TBranch = {
+        channel?: string;
+        tags: string[];
+        type: string;
+        name: string;
+        range: string;
+        accept: TReleaseType[];
+        main: boolean;
+    };
+    export type TSemrelContext = Context & {
+        cwd: string;
+        branch?: TBranch;
+        branches: string[];
+    };
+    export type TPluginConfig = Record<any, any>;
+    export type TPluginMethod<T = void> = (pluginConfig: TPluginConfig, context: TSemrelContext) => Promise<T>;
+    export interface TPlugin {
+        verifyConditions?: TPluginMethod;
+        analyzeCommits?: TPluginMethod<TReleaseType>;
+        verifyRelease?: TPluginMethod;
+        generateNotes?: TPluginMethod<string>;
+        prepare?: TPluginMethod;
+        publish?: TPluginMethod;
+        addChannel?: TPluginMethod;
+        success?: TPluginMethod;
+        fail?: TPluginMethod;
+    }
+    export type TReleaseStep = keyof TPlugin;
+    export type TStepConfigs = Record<TReleaseStep, TPluginConfig | undefined>;
+    export type TPluginHandlerContext = {
+        pluginConfig: TPluginConfig;
+        stepConfig?: TPluginConfig;
+        stepConfigs: TStepConfigs;
+        context: TSemrelContext;
+        step: TReleaseStep;
+        debug: Debugger;
+    };
+    export type TReleaseHandler = (context: TPluginHandlerContext) => Promise<any>;
+    export type TPluginFactoryOptionsNormalized = {
+        handler: TReleaseHandler;
+        name?: string;
+        include: TReleaseStep[];
+        exclude: TReleaseStep[];
+        require: TReleaseStep[];
+        debug: Debugger;
+    };
+    export type TPluginFactoryOptions = Partial<Omit<TPluginFactoryOptionsNormalized, 'debug'> & {
+        debug: string | Debugger;
+    }>;
+    export type TPluginFactory = (handler: TPluginFactoryOptions | TReleaseHandler) => TPlugin;
+    export type TPluginMetaContext = {
+        invoked: TReleaseStep[];
+    };
+}
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

81394

increased by33.21%

Number of package files

33

increased by32%

Lines of code

1373

increased by37.99%

Worsened metrics

Number of low supply chain risk alerts

6

increased by50%

Is type module

No

Dependency changes

• Updated@qiwi/esm@^1.1.1

• Updated@types/node@^16.11.7

• Updated@types/semantic-release@^17.2.3