chore(types): add type check [skip ci]

Author: lgaticaq

.huskyrc.json

@@ -1,6 +1,6 @@
 {
   "hooks": {
-    "pre-commit": "lint-staged",
+    "pre-commit": "npm run ts-compile-check && lint-staged",
     "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
   }
 }

package-lock.json

@@ -5,6 +5,7 @@
   "main": "src/index.js",
   "scripts": {
     "lint": "prettier-standard --lint '{src,test}/**/*.js'",
+    "ts-compile-check": "tsc -p tsconfig.json --noEmit",
     "test": "nyc mocha test"
   },
   "engines": {
@@ -37,6 +38,7 @@
     "@types/chai": "4.2.12",
     "@types/mocha": "8.0.3",
     "@types/node": "12.12.55",
+    "@types/semantic-release": "17.1.0",
     "chai": "4.2.0",
     "eslint": "7.8.1",
     "eslint-plugin-array-func": "3.1.7",
@@ -57,7 +59,8 @@
     "semantic-release": "17.1.1",
     "sinon": "9.0.3",
     "stream-buffers": "3.0.2",
-    "tempy": "0.6.0"
+    "tempy": "0.6.0",
+    "typescript": "4.0.2"
   },
   "peerDependencies": {
     "semantic-release": ">=11.0.0 <18.0.0"

package.json

@@ -1,11 +1,20 @@
 /**
- * @typedef {import('semantic-release').Context} Context
+ * @typedef {import('./types').Context} Context
+ * @typedef {import('./types').SemanticReleaseError} SemanticReleaseError
  */
+
+const pkg = require('../package.json')
+
+const [homepage] = pkg.homepage.split('#')
+/* eslint-disable no-unused-vars */
 /**
- * @typedef {Object} SemanticReleaseError
- * @property {string} message -
- * @property {string} details -
+ * @param {string} file -
+ * @returns {string} -
+ * @example
+ * const link = linkify(href)
  */
+const linkify = file => `${homepage}/blob/master/${file}`
+/* eslint-enable no-unused-vars */
 
 module.exports = new Map([
   [
@@ -14,7 +23,7 @@ module.exports = new Map([
      * @param {Context} ctx -
      * @returns {SemanticReleaseError} -
      */
-    (ctx) => ({
+    ctx => ({
       message: 'A custom message.',
       details: 'A custom description.'
     })

src/errors.js

@@ -1,15 +1,15 @@
 const SemanticReleaseError = require('@semantic-release/error')
 const ERROR_DEFINITIONS = require('./errors')
 
-/** @typedef {import('semantic-release').Context} Context */
+/** @typedef {import('./types').Context} Context */
 /**
  * @param {string} code -
  * @param {Context} ctx -
  * @returns {Error} -
  * @example
  * const throw getError('CUSTOMERROR')
  */
-module.exports = (code, ctx = {}) => {
+module.exports = (code, ctx) => {
   const { message, details } = ERROR_DEFINITIONS.get(code)(ctx)
   return new SemanticReleaseError(message, code, details)
 }

src/get-error.js

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('semantic-release').Context} Context
- * @typedef {import('semantic-release').Config} Config
+ * @typedef {import('./types').Context} Context
+ * @typedef {import('./types').Config} Config
  */
 /**
  * @param {Config} pluginConfig -

src/publish.js

@@ -0,0 +1,17 @@
+import {
+  Config as SemanticReleaseConfig,
+  Context as SemanticReleaseContext,
+  Result as SemanticReleaseResult
+} from 'semantic-release'
+
+export interface Context
+  extends SemanticReleaseContext,
+    SemanticReleaseConfig,
+    SemanticReleaseResult {}
+
+export interface Config {}
+
+export interface SemanticReleaseError {
+  message: string
+  details: string
+}

src/types.d.ts

@@ -1,8 +1,8 @@
 const getError = require('./get-error')
 
 /**
- * @typedef {import('semantic-release').Context} Context
- * @typedef {import('semantic-release').Config} Config
+ * @typedef {import('./types').Context} Context
+ * @typedef {import('./types').Config} Config
  */
 /**
  * @param {Config} pluginConfig -
@@ -13,6 +13,6 @@ const getError = require('./get-error')
  */
 module.exports = (pluginConfig, ctx) => {
   if (!ctx.env.CUSTOM_ENV) {
-    throw getError('CUSTOMERROR')
+    throw getError('CUSTOMERROR', ctx)
   }
 }

src/verify.js

@@ -1,26 +1,27 @@
-const { describe, it, before } = require('mocha')
+const { describe, it } = require('mocha')
 const { expect } = require('chai')
 const tempy = require('tempy')
 const verify = require('../src/verify')
 
 describe('Verify', () => {
-  let cwd
-
-  before(() => {
-    cwd = tempy.directory()
-  })
+  /** @type {import('../src/types').Context} */
+  const ctx = {
+    cwd: tempy.directory(),
+    env: {},
+    logger: { log: () => ({}), error: () => ({}) }
+  }
 
   it('Return SemanticReleaseError if a custom environment variable is not defined', async () => {
     try {
-      await verify({}, { cwd, env: {} })
+      await verify({}, ctx)
     } catch (err) {
       expect(err.name).to.equal('SemanticReleaseError')
       expect(err.code).to.equal('CUSTOMERROR')
     }
   })
 
   it('Verify alias from a custom environmen variable', async () => {
-    const env = { CUSTOM_ENV: 'custom' }
-    expect(await verify({}, { cwd, env })).to.be.a('undefined')
+    ctx.env = { CUSTOM_ENV: 'custom' }
+    expect(await verify({}, ctx)).to.be.a('undefined')
   })
 })

test/verify.test.js

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "lib": [ "es2017", "es7" ],
+    "allowJs": true,
+    "checkJs": true,
+    "downlevelIteration": true,
+    "outDir": "build",
+    "skipLibCheck": true,
+    "resolveJsonModule": true
+  },
+  "exclude": [
+    "node_modules",
+    "coverage"
+  ]
+}