infrastructure configured

Author: korniychuk

.eslintrc.js

@@ -82,7 +82,10 @@ module.exports = {
       files: ['**/*.ts'],
       parser: '@typescript-eslint/parser',
       parserOptions: {
-        project: './tsconfig.json',
+        project: [
+          './tsconfig.json',
+          './tests/tsconfig.json',
+        ],
         ecmaVersion: 2020,
       },
       "settings": {

.gitignore

@@ -180,6 +180,7 @@ fabric.properties
 
 # JavaScript, TypeScript, NodeJS
 /dist
+/coverage
 /package-lock.json
 /node_modules
 *.tsbuildinfo

README.md

@@ -38,7 +38,7 @@ Add `api-entity-ref` to the plugins section of your `.eslintrc` configuration fi
 {
   "plugins": ["api-entity-ref"],
   "rules": {
-    "api-entity-ref/decorator": "error"
+    "api-entity-ref/check-class-decorator": "error"
   }
 }
 ```
@@ -68,23 +68,23 @@ Or enable the ruleset via the `extends` property of your `.eslintrc` configurati
 
 ### How to make a build
 
-`npm run build`
+`yarn run build`
 
 ### How to run lint
 
-* Just show problems `npm run lint`
-* Fix problems if it is possible `npm run lint:fix`
+* Just show problems `yarn run lint`
+* Fix problems if it is possible `yarn run lint:fix`
 
 ### How to run tests
 
 * All tests
 
-  `npm run test`  
-  `npm run test:watch`
+  `yarn run test`  
+  `yarn run test:watch`
 * Specific tests
 
-  `npm run test -- src/my.spec.ts`  
-  `npm run test:watch -- src/my.spec.ts`
+  `yarn run test -- src/my.spec.ts`  
+  `yarn run test:watch -- src/my.spec.ts`
 
 ## Author
 

jest.config.js

@@ -1,6 +1,8 @@
 // For a detailed explanation regarding each configuration property, visit:
 // https://jestjs.io/docs/en/configuration.html
 
+const toBoolean = value => (value === 'true' ? true : !!+value);
+
 module.exports = {
   // All imported modules in your tests should be mocked automatically
   // automock: false,
@@ -18,10 +20,10 @@ module.exports = {
   // clearMocks: false,
 
   // Indicates whether the coverage information should be collected while executing the test
-  // collectCoverage: false,
+  collectCoverage: toBoolean(process.env.JEST_COLLECT_COVERAGE),
 
   // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: null,
+  collectCoverageFrom: ['src/**/*.ts'],
 
   // The directory where Jest should output its coverage files
   // coverageDirectory: null,
@@ -32,12 +34,13 @@ module.exports = {
   // ],
 
   // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
+  coverageReporters: [
   //   "json",
   //   "text",
-  //   "lcov",
+    'lcov',
+    'text-summary',
   //   "clover"
-  // ],
+  ],
 
   // An object that configures minimum threshold enforcement for coverage results
   // coverageThreshold: null,
@@ -58,7 +61,11 @@ module.exports = {
   // globalTeardown: null,
 
   // A set of global variables that need to be available in all test environments
-  // globals: {},
+  globals: {
+    'ts-jest': {
+      tsConfig: 'tests/tsconfig.json',
+    },
+  },
 
   // 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%",
@@ -112,7 +119,7 @@ module.exports = {
   // restoreMocks: false,
 
   // The root directory that Jest should scan for tests and modules within
-  rootDir: 'src',
+  // rootDir: 'src',
 
   // A list of paths to directories that Jest should use to search for files in
   // roots: [
@@ -133,6 +140,7 @@ module.exports = {
 
   // The test environment that will be used for testing
   // testEnvironment: "jest-environment-jsdom",
+  testEnvironment: 'node',
 
   // Options that will be passed to the testEnvironment
   // testEnvironmentOptions: {},

package.json

@@ -20,7 +20,7 @@
   "scripts": {
     "build": "rimraf dist && tsc -p tsconfig.build.json",
     "build:prod": "npm run build",
-    "lint": "eslint --ext .js,.ts src/**",
+    "lint": "eslint --ext .js,.ts ./{src,tests}/**/*.ts",
     "lint:fix": "npm run lint -- --fix",
     "pre-push": "npm run lint && npm run test && npm run build:prod && npm run tpl-repo:check",
     "preinstall": "node ./tools/check-yarn.js",
@@ -36,6 +36,7 @@
     "@babel/preset-env": "~7.7.6",
     "@babel/preset-typescript": "~7.7.4",
     "@types/jest": "~25.1.0",
+    "@types/node": "^13.9.1",
     "@typescript-eslint/eslint-plugin": "~2.14.0",
     "@typescript-eslint/parser": "~2.14.0",
     "eslint": "~6.8.0",

src/index.ts

@@ -0,0 +1,4 @@
+export { rules } from './rules';
+export const configs = {
+  ccc: 'ddd',
+};

src/my.spec.ts

@@ -0,0 +1,3 @@
+export const rules = {
+  aaa: 'bbb',
+};

src/my.ts

@@ -0,0 +1,5 @@
+describe('check-class-decorator', () => {
+  it('THEN: description ...', () => {
+    expect(1).toBe(1);
+  });
+});

src/global.d.ts renamed to src/rules/check-class-decorator.ts

@@ -0,0 +1,5 @@
+{
+  "exclude": [ "node_modules", "dist" ],
+  "include": [ "**/*.ts" ],
+  "extends": "../tsconfig.json"
+}

src/rules/index.ts

@@ -13,19 +13,17 @@
     "moduleResolution": "node",
     "noEmitHelpers": true,
     "removeComments": true,
-    "sourceMap": true,
     "strict": true,
     "target": "es2019",
     "typeRoots": [
       "node_modules/@types"
     ],
     "types": [
       "jest",
-      "jest-extended"
+      "jest-extended",
+      "node"
     ],
-    "outDir": "./dist",
-    "baseUrl": "./src",
-    "rootDir": "./src"
+    "outDir": "./dist"
   },
   "include": [
     "src/**/*.ts"

tests/rules/check-class-decorator.spec.ts

@@ -1025,6 +1025,11 @@
   resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee"
   integrity sha1-7ihweulOEdK4J7y+UnC86n8+ce4=
 
+"@types/node@^13.9.1":
+  version "13.9.1"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-13.9.1.tgz#96f606f8cd67fb018847d9b61e93997dabdefc72"
+  integrity sha512-E6M6N0blf/jiZx8Q3nb0vNaswQeEyn0XlupO+xN6DtJ6r6IT4nXrTry7zhIfYvFCl3/8Cu6WIysmUBKiqV0bqQ==
+
 "@types/normalize-package-data@^2.4.0":
   version "2.4.0"
   resolved "https://registry.yarnpkg.com/@types/normalize-package-data/-/normalize-package-data-2.4.0.tgz#e486d0d97396d79beedd0a6e33f4534ff6b4973e"