From 3d3032aa71c6da3418bd8679100a1f9377a852e5 Mon Sep 17 00:00:00 2001 From: syuilo Date: Sat, 26 Jun 2021 23:48:46 +0900 Subject: [PATCH] Introduce coverage integration --- .github/workflows/test.yml | 2 + .gitignore | 4 + README.md | 2 + codecov.yml | 2 + jest.config.ts | 197 +++++++++++++++++++++++++++++++++++++ package.json | 14 ++- test-d/index.ts | 2 +- test/api.ts | 4 +- test/parser.ts | 4 +- 9 files changed, 221 insertions(+), 10 deletions(-) create mode 100644 codecov.yml create mode 100644 jest.config.ts diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 510fb08..ac5f86f 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -32,3 +32,5 @@ jobs: run: npm run build - name: Test run: npm run test + - name: Upload Coverage + uses: codecov/codecov-action@v1 diff --git a/.gitignore b/.gitignore index a8811cf..8122c67 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,7 @@ package-lock.json # app dir built temp + +coverage + +src/internal/parser.js diff --git a/README.md b/README.md index 781f938..71e516e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ An MFM parser implementation with PEG.js. [![Test](https://github.com/misskey-dev/mfm.js/actions/workflows/test.yml/badge.svg)](https://github.com/misskey-dev/mfm.js/actions/workflows/test.yml) +[![codecov](https://codecov.io/gh/misskey-dev/mfm.js/branch/develop/graph/badge.svg?token=irAWFiHK8T)](https://codecov.io/gh/misskey-dev/mfm.js) + [![NPM](https://nodei.co/npm/mfm-js.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/mfm-js) ## Installation diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..50ec5f2 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,2 @@ +codecov: + token: fcfdc680-8bb5-4185-ad31-22b1e1e4c207 diff --git a/jest.config.ts b/jest.config.ts new file mode 100644 index 0000000..6a87bc4 --- /dev/null +++ b/jest.config.ts @@ -0,0 +1,197 @@ +/* +* For a detailed explanation regarding each configuration property and type check, visit: +* https://jestjs.io/docs/en/configuration.html +*/ + +export default { + // All imported modules in your tests should be mocked automatically + // automock: false, + + // Stop running tests after `n` failures + // bail: 0, + + // The directory where Jest should store its cached dependency information + // cacheDirectory: "C:\\Users\\ai\\AppData\\Local\\Temp\\jest", + + // Automatically clear mock calls and instances between every test + // clearMocks: false, + + // Indicates whether the coverage information should be collected while executing the test + // collectCoverage: false, + + // An array of glob patterns indicating a set of files for which coverage information should be collected + collectCoverageFrom: ['src/**/*.ts', '!src/cli/**/*.ts'], + + // The directory where Jest should output its coverage files + coverageDirectory: "coverage", + + // An array of regexp pattern strings used to skip coverage collection + // coveragePathIgnorePatterns: [ + // "\\\\node_modules\\\\" + // ], + + // Indicates which provider should be used to instrument code for coverage + coverageProvider: "v8", + + // A list of reporter names that Jest uses when writing coverage reports + // coverageReporters: [ + // "json", + // "text", + // "lcov", + // "clover" + // ], + + // An object that configures minimum threshold enforcement for coverage results + // coverageThreshold: undefined, + + // A path to a custom dependency extractor + // dependencyExtractor: undefined, + + // Make calling deprecated APIs throw helpful error messages + // errorOnDeprecated: false, + + // Force coverage collection from ignored files using an array of glob patterns + // forceCoverageMatch: [], + + // A path to a module which exports an async function that is triggered once before all test suites + // globalSetup: undefined, + + // A path to a module which exports an async function that is triggered once after all test suites + // globalTeardown: undefined, + + // A set of global variables that need to be available in all test environments + // globals: {}, + + // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers. + // maxWorkers: "50%", + + // An array of directory names to be searched recursively up from the requiring module's location + // moduleDirectories: [ + // "node_modules" + // ], + + // An array of file extensions your modules use + // moduleFileExtensions: [ + // "js", + // "json", + // "jsx", + // "ts", + // "tsx", + // "node" + // ], + + // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module + // moduleNameMapper: {}, + + // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader + // modulePathIgnorePatterns: [], + + // Activates notifications for test results + // notify: false, + + // An enum that specifies notification mode. Requires { notify: true } + // notifyMode: "failure-change", + + // A preset that is used as a base for Jest's configuration + // preset: undefined, + + // Run tests from one or more projects + // projects: undefined, + + // Use this configuration option to add custom reporters to Jest + // reporters: undefined, + + // Automatically reset mock state between every test + // resetMocks: false, + + // Reset the module registry before running each individual test + // resetModules: false, + + // A path to a custom resolver + // resolver: undefined, + + // Automatically restore mock state between every test + // restoreMocks: false, + + // The root directory that Jest should scan for tests and modules within + // rootDir: undefined, + + // A list of paths to directories that Jest should use to search for files in + roots: [ + "" + ], + + // Allows you to use a custom runner instead of Jest's default test runner + // runner: "jest-runner", + + // The paths to modules that run some code to configure or set up the testing environment before each test + // setupFiles: [], + + // A list of paths to modules that run some code to configure or set up the testing framework before each test + // setupFilesAfterEnv: [], + + // The number of seconds after which a test is considered as slow and reported as such in the results. + // slowTestThreshold: 5, + + // A list of paths to snapshot serializer modules Jest should use for snapshot testing + // snapshotSerializers: [], + + // The test environment that will be used for testing + testEnvironment: "node", + + // Options that will be passed to the testEnvironment + // testEnvironmentOptions: {}, + + // Adds a location field to test results + // testLocationInResults: false, + + // The glob patterns Jest uses to detect test files + testMatch: [ + "**/__tests__/**/*.[jt]s?(x)", + "**/?(*.)+(spec|test).[tj]s?(x)", + "/test/**/*" + ], + + // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped + // testPathIgnorePatterns: [ + // "\\\\node_modules\\\\" + // ], + + // The regexp pattern or array of patterns that Jest uses to detect test files + // testRegex: [], + + // This option allows the use of a custom results processor + // testResultsProcessor: undefined, + + // This option allows use of a custom test runner + // testRunner: "jasmine2", + + // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href + // testURL: "http://localhost", + + // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout" + // timers: "real", + + // A map from regular expressions to paths to transformers + transform: { + "^.+\\.(ts|tsx)$": "ts-jest" + }, + + // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation + // transformIgnorePatterns: [ + // "\\\\node_modules\\\\", + // "\\.pnp\\.[^\\\\]+$" + // ], + + // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them + // unmockedModulePathPatterns: undefined, + + // Indicates whether each individual test should be reported during the run + // verbose: undefined, + + // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode + // watchPathIgnorePatterns: [], + + // Whether to use watchman for file crawling + // watchman: true, +}; diff --git a/package.json b/package.json index c9d782a..06dbf8e 100644 --- a/package.json +++ b/package.json @@ -7,13 +7,15 @@ "scripts": { "build": "npm run tsc && npm run peg", "build-debug": "npm run tsc && npm run peg-debug", - "peg": "peggy --cache -o built/internal/parser.js --allowed-start-rules fullParser,inlineParser,plainParser src/internal/parser.pegjs", - "peg-debug": "peggy --cache -o built/internal/parser.js --allowed-start-rules fullParser,inlineParser,plainParser --trace src/internal/parser.pegjs", + "peg": "peggy --cache -o src/internal/parser.js --allowed-start-rules fullParser,inlineParser,plainParser src/internal/parser.pegjs && npm run peg-copy", + "peg-debug": "peggy --cache -o src/internal/parser.js --allowed-start-rules fullParser,inlineParser,plainParser --trace src/internal/parser.pegjs && npm run peg-copy", + "peg-copy": "copyfiles -f src/internal/parser.js built/internal/", "tsc": "tsc", "tsd": "tsd", "parse": "node ./built/cli/parse", "parse-plain": "node ./built/cli/parsePlain", - "test": "mocha -r ts-node/register 'test/**/*.ts' && npm run tsd" + "jest": "jest --coverage", + "test": "npm run jest && npm run tsd" }, "repository": { "type": "git", @@ -22,10 +24,12 @@ "author": "Marihachi", "license": "MIT", "devDependencies": { - "@types/mocha": "8.2.x", + "@types/jest": "^26.0.23", "@types/node": "14.14.x", - "mocha": "8.3.x", + "copyfiles": "^2.4.1", + "jest": "^27.0.5", "peggy": "1.2.0", + "ts-jest": "^27.0.3", "ts-node": "9.1.x", "tsd": "^0.14.0", "typescript": "4.2.x" diff --git a/test-d/index.ts b/test-d/index.ts index 8a819e6..160a025 100644 --- a/test-d/index.ts +++ b/test-d/index.ts @@ -4,7 +4,7 @@ */ import { expectType } from 'tsd'; -import { NodeType, MfmUrl } from '../built'; +import { NodeType, MfmUrl } from '../src'; describe('#NodeType', () => { it('returns node that has sprcified type', () => { diff --git a/test/api.ts b/test/api.ts index 729e120..a5756f4 100644 --- a/test/api.ts +++ b/test/api.ts @@ -1,8 +1,8 @@ import assert from 'assert'; -import * as mfm from '../built/index'; +import * as mfm from '../src/index'; import { TEXT, CENTER, FN, UNI_EMOJI, MENTION, EMOJI_CODE, HASHTAG, N_URL, BOLD, SMALL, ITALIC, STRIKE, QUOTE, MATH_BLOCK, SEARCH, CODE_BLOCK, LINK -} from '../built/index'; +} from '../src/index'; describe('API', () => { describe('toString', () => { diff --git a/test/parser.ts b/test/parser.ts index 216cf1f..eda18da 100644 --- a/test/parser.ts +++ b/test/parser.ts @@ -1,8 +1,8 @@ import assert from 'assert'; -import * as mfm from '../built/index'; +import * as mfm from '../src/index'; import { TEXT, CENTER, FN, UNI_EMOJI, MENTION, EMOJI_CODE, HASHTAG, N_URL, BOLD, SMALL, ITALIC, STRIKE, QUOTE, MATH_BLOCK, SEARCH, CODE_BLOCK, LINK, INLINE_CODE, MATH_INLINE -} from '../built/index'; +} from '../src/index'; describe('PlainParser', () => { describe('text', () => {