lcov-badge2 1.0.3 → 1.1.0

package/.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{json,yml}]
+indent_size = 2
+max_line_length = off
+
+[*.md]
+max_line_length = off

package/.eslintrc.yml

@@ -0,0 +1,343 @@
+root: true
+parser: '@typescript-eslint/parser'
+parserOptions:
+  project: tsconfig.json
+  sourceType: module
+env:
+  node: true
+  jest: true
+  jest/globals: true
+plugins:
+  - '@typescript-eslint'
+  - 'import'
+  - 'jest'
+  - 'unicorn'
+extends:
+  - 'eslint:recommended'
+  - 'plugin:@typescript-eslint/eslint-recommended'
+  - 'plugin:@typescript-eslint/recommended'
+settings:
+  import/internal-regex: '^(config|core|http-server|logging|operation-log|persistence|test|utils)/'
+rules:
+  array-bracket-spacing:
+    - error
+    - never
+  arrow-parens: error
+  arrow-spacing: error
+  block-spacing:
+    - error
+    - always
+  brace-style:
+    - error
+    - 1tbs
+  camelcase: off
+  class-methods-use-this:
+    - warn
+    - exceptMethods:
+        - 'intercept'
+        - 'configure'
+        - 'getSession'
+  complexity: error
+  comma-dangle:
+    - warn
+    - always-multiline
+  computed-property-spacing:
+    - error
+    - never
+  constructor-super: error
+  curly: error
+  dot-notation: error
+  eol-last: error
+  eqeqeq:
+    - error
+    - always
+    - null: never
+  func-call-spacing:
+    - error
+    - never
+  func-style:
+    - error
+    - declaration
+  generator-star-spacing: error
+  guard-for-in: error
+  key-spacing: error
+  keyword-spacing: error
+  linebreak-style: error
+  max-len:
+    - error
+    - code: 120
+      ignoreTemplateLiterals: true
+      ignoreComments: true
+  new-parens: error
+  no-bitwise: error
+  no-caller: error
+  no-console: error
+  no-constant-condition: error
+  no-debugger: error
+  no-delete-var: error
+  no-eval: error
+  no-extra-bind: error
+  no-extra-semi: error
+  no-invalid-this: error
+  no-invalid-regexp: error
+  no-irregular-whitespace: error
+  no-multi-spaces:
+    - error
+    - ignoreEOLComments: true
+  no-multi-str: error
+  no-multiple-empty-lines:
+    - error
+    - max: 1
+      maxBOF: 0
+      maxEOF: 1
+  no-new-func: error
+  no-new-wrappers: error
+  no-octal-escape: error
+  no-param-reassign: error
+  no-plusplus:
+    - error
+    - allowForLoopAfterthoughts: true
+  no-regex-spaces: error
+  no-restricted-imports:
+    # this is a workaround for this bug: https://github.com/benmosher/eslint-plugin-import/issues/1610
+    - error
+    - patterns:
+        - '../*'
+  no-return-await: error
+  no-sequences: error
+  no-shadow: off # replaced by typescript-eslint/no-shadow rule below because of: https://github.com/typescript-eslint/typescript-eslint/issues/2471
+  no-sparse-arrays: error
+  no-template-curly-in-string: error
+  no-trailing-spaces: error
+  no-undef-init: error
+  no-unsafe-finally: error
+  no-unused-expressions: off
+  no-unused-labels: error
+  no-useless-rename: error
+  no-var: error
+  no-void: error
+  no-warning-comments: warn
+  no-whitespace-before-property: error
+  no-with: error
+  object-curly-spacing:
+    - error
+    - always
+  object-shorthand:
+    - error
+    - always
+    - avoidQuotes: true
+  one-var:
+    - error
+    - never
+  padded-blocks:
+    - error
+    - never
+  prefer-const: error
+  prefer-object-spread: error
+  prefer-template: error
+  quotes:
+    - error
+    - single
+    - avoidEscape: true
+  quote-props:
+    - error
+    - as-needed
+  radix: error
+  rest-spread-spacing: error
+  semi-spacing: error
+  space-before-function-paren:
+    - error
+    - asyncArrow: always
+      anonymous: always
+      named: never
+  space-in-parens:
+    - error
+    - never
+  space-infix-ops: error
+  space-unary-ops: error
+  spaced-comment: error
+  switch-colon-spacing: error
+  template-curly-spacing: error
+  template-tag-spacing: error
+  use-isnan: error
+  valid-typeof: error
+  yield-star-spacing: error
+
+  import/export: error
+  import/first: error
+  import/no-cycle: error
+  import/order:
+    - error
+    - groups:
+        - [builtin, external]
+        - [internal]
+        - [sibling, parent, index]
+      newlines-between: always
+      alphabetize:
+        order: asc
+  import/no-deprecated: warn
+  import/no-duplicates: error
+  import/no-extraneous-dependencies: error
+  import/no-mutable-exports: error
+  import/no-relative-parent-imports: error
+  import/no-unused-modules: error
+  jest/consistent-test-it:
+    - error
+    - fn: test
+  jest/expect-expect:
+    - error
+    - assertFunctionNames:
+        - expect
+        - assert*
+  jest/no-alias-methods: error
+  jest/no-commented-out-tests: warn
+  jest/no-deprecated-functions: warn
+  jest/no-disabled-tests: warn
+  #  https://github.com/jest-community/eslint-plugin-jest/issues/642
+  #  jest/no-duplicate-hooks: error
+  jest/no-export: error
+  jest/no-focused-tests: error
+  jest/no-identical-title: error
+  jest/no-if: warn
+  jest/no-jasmine-globals: error
+  jest/no-mocks-import: error
+  jest/no-standalone-expect:
+    - error
+    - additionalTestBlockFunctions:
+        - beforeEach
+  jest/no-test-prefixes: warn
+  jest/no-test-return-statement: error
+  jest/prefer-lowercase-title:
+    - error
+    - ignore:
+        - describe
+  jest/prefer-spy-on: error
+  jest/prefer-to-be: error
+  jest/prefer-to-contain: error
+  jest/prefer-to-have-length: warn
+  jest/prefer-todo: error
+  jest/require-to-throw-message: error
+  jest/valid-describe-callback: error
+  jest/valid-expect: error
+  jest/valid-expect-in-promise: error
+  unicorn/filename-case: error
+
+  # typescript-specific
+  '@typescript-eslint/array-type':
+    - error
+    - default: array
+  '@typescript-eslint/await-thenable': error
+  '@typescript-eslint/adjacent-overload-signatures': error
+  '@typescript-eslint/consistent-type-assertions':
+    - error
+    - assertionStyle: as
+  '@typescript-eslint/explicit-function-return-type':
+    - error
+    - allowExpressions: true
+  '@typescript-eslint/explicit-module-boundary-types':
+    - error
+    - allowHigherOrderFunctions: true
+      allowTypedFunctionExpressions: true
+  '@typescript-eslint/member-delimiter-style':
+    - error
+    - singleline:
+        delimiter: comma
+        requireLast: false
+  '@typescript-eslint/member-ordering':
+    - error
+    - default:
+        - static-field
+        - instance-field
+        - static-method
+        - instance-method
+  '@typescript-eslint/naming-convention':
+    - error
+    - selector: default
+      format:
+        - camelCase
+      leadingUnderscore: allow
+      trailingUnderscore: forbid
+    - selector: variable
+      format:
+        - camelCase
+        - PascalCase
+        - UPPER_CASE
+      leadingUnderscore: allow
+    - selector: function
+      format:
+        - camelCase
+        - PascalCase
+    - selector: property
+      format:
+        - camelCase
+        - PascalCase
+        - snake_case
+        - UPPER_CASE
+      leadingUnderscore: allow
+    - selector: enumMember
+      format:
+        - PascalCase
+    - selector: typeLike
+      format:
+        - PascalCase
+  '@typescript-eslint/no-array-constructor': error
+  '@typescript-eslint/no-dynamic-delete': error
+  '@typescript-eslint/no-explicit-any': error
+  '@typescript-eslint/no-empty-function':
+    - error
+    - allow:
+        - 'arrowFunctions'
+  '@typescript-eslint/no-empty-interface':
+    - error
+    - allowSingleExtends: true
+  '@typescript-eslint/no-extraneous-class': error
+  '@typescript-eslint/no-floating-promises': error
+  '@typescript-eslint/no-for-in-array': error
+  '@typescript-eslint/no-misused-new': error
+  '@typescript-eslint/no-require-imports': error
+  "@typescript-eslint/no-shadow": error
+  '@typescript-eslint/no-this-alias': error
+  '@typescript-eslint/no-throw-literal': error
+  '@typescript-eslint/no-unnecessary-qualifier': error
+  '@typescript-eslint/no-unnecessary-type-arguments': error
+  '@typescript-eslint/no-unnecessary-type-assertion': error
+  '@typescript-eslint/no-unused-vars':
+    - error
+    - ignoreRestSiblings: true
+      argsIgnorePattern: 'error|_.*'
+      varsIgnorePattern: '^_.*'
+  '@typescript-eslint/no-use-before-define':
+    - error
+    - functions: false
+      classes: false
+  '@typescript-eslint/no-useless-constructor': error
+  '@typescript-eslint/no-var-requires': error
+  '@typescript-eslint/prefer-for-of': error
+  '@typescript-eslint/prefer-function-type': error
+  '@typescript-eslint/prefer-nullish-coalescing': warn
+  '@typescript-eslint/prefer-optional-chain': error
+  '@typescript-eslint/prefer-readonly': error
+  '@typescript-eslint/promise-function-async': error
+  '@typescript-eslint/require-await': error
+  '@typescript-eslint/restrict-plus-operands': error
+  '@typescript-eslint/semi': error
+  '@typescript-eslint/type-annotation-spacing': error
+  '@typescript-eslint/unbound-method':
+    - error
+    - ignoreStatic: true
+  '@typescript-eslint/unified-signatures': error
+overrides:
+  - files:
+      - 'cli*.ts'
+      - 'main*.ts'
+    rules:
+      no-console: off
+  - files:
+      - '*.spec.ts'
+    rules:
+      class-methods-use-this: off
+      no-unused-expressions: off
+      '@typescript-eslint/no-empty-function': off
+      '@typescript-eslint/no-explicit-any': off
+      '@typescript-eslint/unbound-method': off
+      '@typescript-eslint/ban-types': off

package/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: weekly
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: weekly

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,37 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '19 4 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'typescript' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

package/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm run coverage
+      - run: npm run lint
+      - name: Codecov
+        uses: codecov/codecov-action@v3.1.4
+        with:
+          directory: ./coverage

package/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+Currently, there's only one major and minor version, so of course it's supported!
+
+| Version | Supported           |
+| ------- | ------------------- |
+| 1.0.x   | :heavy_check_mark:  |
+
+## Reporting a Vulnerability
+
+If you notice a vulnerability, please open an issue or, if you'd like to fix it yourself, a pull request.
+You can expect a response within a couple of days at the latest.

package/gulpfile.mjs

@@ -0,0 +1,20 @@
+import { deleteAsync } from 'del';
+import gulp from 'gulp';
+import header from 'gulp-header';
+
+export async function clean() {
+    await deleteAsync(['dist']);
+}
+
+function addShebang() {
+    return gulp.src('dist/main.js')
+        .pipe(header('#!/usr/bin/env node\n'))
+        .pipe(gulp.dest('dist'));
+}
+
+function copyPackageFiles() {
+    return gulp.src(['package.json', 'README.md', 'LICENSE'])
+        .pipe(gulp.dest('dist'));
+}
+
+export const postbuild = gulp.series(addShebang, copyPackageFiles);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lcov-badge2",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Generate a badge from a LCOV report",
   "keywords": [
     "lcov",
@@ -32,33 +32,31 @@
     "lint": "eslint src/**/*.ts"
   },
   "dependencies": {
-    "badge-up": "^3.0.0",
+    "badge-up2": "^1.0.0",
     "minimist": "^1.2.5",
     "minimist-options": "^4.1.0",
     "parse-lcov": "^1.0.4"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.3",
+    "@types/jest": "^29.2.0",
     "@types/minimist": "^1.2.2",
-    "@types/minimist-options": "^4.0.1",
-    "@types/node": "^16.11.12",
-    "@typescript-eslint/eslint-plugin": "^5.6.0",
-    "@typescript-eslint/parser": "^5.6.0",
-    "del": "^6.0.0",
+    "@types/node": "^20.3.3",
+    "@typescript-eslint/eslint-plugin": "^6.4.1",
+    "@typescript-eslint/parser": "^6.4.1",
+    "del": "^7.0.0",
     "eslint": "^8.4.1",
     "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jest": "^25.3.0",
-    "eslint-plugin-unicorn": "^39.0.0",
+    "eslint-plugin-jest": "^27.1.3",
+    "eslint-plugin-unicorn": "^48.0.1",
     "gulp": "^4.0.2",
     "gulp-header": "^2.0.9",
-    "jest": "^27.4.4",
-    "pre-commit": "^1.2.2",
-    "ts-jest": "^27.1.1",
+    "jest": "^29.2.2",
+    "ts-jest": "^29.0.3",
     "ts-node": "^10.4.0",
-    "typescript": "^4.5.3"
+    "typescript": "^5.0.3"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "jest": {
     "moduleFileExtensions": [
@@ -78,10 +76,7 @@
       "**/*.ts"
     ],
     "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
-  },
-  "pre-commit": [
-    "lint",
-    "test"
-  ]
+    "testEnvironment": "node",
+    "maxWorkers": 1
+  }
 }

package/src/badge.spec.ts

@@ -0,0 +1,36 @@
+import badge, { colors } from 'badge-up2';
+
+import { createBadge } from './badge';
+
+jest.mock('badge-up2');
+
+describe('Badge', () => {
+    beforeEach(() => {
+        (badge as jest.MockedFunction<typeof badge>).mockResolvedValue('this is a badge');
+    });
+
+    describe('Creating badge', () => {
+        test('it returns the badge contents', async () => {
+            const contents = await createBadge('coverage', 12.34);
+            expect(contents).toBe('this is a badge');
+        });
+
+        test.each([
+            [colors.red, 0],
+            [colors.red, 75],
+            [colors.orange, 75.01],
+            [colors.orange, 85],
+            [colors.yellow, 85.01],
+            [colors.yellow, 90],
+            [colors.yellowgreen, 90.01],
+            [colors.yellowgreen, 93],
+            [colors.green, 93.01],
+            [colors.green, 97],
+            [colors.brightgreen, 97.01],
+            [colors.brightgreen, 100],
+        ])('the color is %s when the coverage is %s', async (color, coverage) => {
+            await createBadge('abc123', coverage);
+            expect(badge).toHaveBeenCalledWith('abc123', `${coverage}%`, color);
+        });
+    });
+});

package/src/badge.ts

@@ -0,0 +1,22 @@
+import badge, { colors } from 'badge-up2';
+
+function getColor(coverage: number): colors {
+    if (coverage > 97) {
+        return colors.brightgreen;
+    } else if (coverage > 93) {
+        return colors.green;
+    } else if (coverage > 90) {
+        return colors.yellowgreen;
+    } else if (coverage > 85) {
+        return colors.yellow;
+    } else if (coverage > 75) {
+        return colors.orange;
+    } else {
+        return colors.red;
+    }
+}
+
+export async function createBadge(label: string, coverage: number): Promise<string> {
+    const color = getColor(coverage);
+    return badge(label, `${coverage}%`, color);
+}