feat: create module

Author: giladgd

.c8rc.json

@@ -0,0 +1,11 @@
+{
+    "check-coverage": true,
+    "all": true,
+    "cache": false,
+    "exclude": ["src/index.ts", "src/cli.ts", "**/*.d.ts"],
+    "extension": [".ts"],
+    "include": ["src/**/*"],
+    "report-dir": "coverage",
+    "lines": 85,
+    "functions": 90
+}

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+
+[{*.ts,*.js}]
+insert_final_newline = true
+
+[{package.json,package-lock.json}]
+indent_size = 2
+
+[*.yml]
+indent_size = 2

.eslintrc.json

@@ -0,0 +1,126 @@
+{
+    "root": true,
+    "env": {
+        "node": true,
+        "browser": false,
+        "es6": true
+    },
+    "ignorePatterns": ["dist/"],
+    "extends": [
+        "eslint:recommended"
+    ],
+    "globals": {
+        "Atomics": "readonly",
+        "SharedArrayBuffer": "readonly"
+    },
+    "parserOptions": {
+        "ecmaFeatures": {
+            "jsx": true
+        },
+        "ecmaVersion": 2021,
+        "sourceType": "module"
+    },
+    "overrides": [{
+        "files": ["**.ts"],
+        "extends": [
+            "eslint:recommended",
+            "plugin:@typescript-eslint/recommended"
+        ],
+        "parser": "@typescript-eslint/parser",
+        "plugins": [
+            "@typescript-eslint",
+            "import",
+            "node"
+        ],
+        "rules": {
+            "@typescript-eslint/explicit-module-boundary-types": ["off"],
+            "@typescript-eslint/ban-ts-comment": ["off"],
+            "@typescript-eslint/no-explicit-any": ["off"],
+            "semi": ["off"],
+            "@typescript-eslint/semi": ["warn", "always"],
+            "@typescript-eslint/no-inferrable-types": ["off"]
+        }
+    }],
+    "plugins": [
+        "@typescript-eslint",
+        "import",
+        "node"
+    ],
+    "settings": {
+        "import/parsers": {
+            "@typescript-eslint/parser": [".ts"]
+        }
+    },
+    "rules": {
+        "indent": ["warn", 4, {
+            "SwitchCase": 1,
+            "FunctionDeclaration": {
+                "parameters": "first"
+            }
+        }],
+        "eqeqeq": ["off"],
+        "no-undef": "off",
+        "quotes": ["warn", "double", { "avoidEscape": true }],
+        "no-unused-vars": ["warn", {
+            "args": "none",
+            "ignoreRestSiblings": true,
+            "varsIgnorePattern": "^set"
+        }],
+        "no-prototype-builtins": ["off"],
+        "object-curly-spacing": ["warn", "never"],
+        "semi": ["warn", "always"],
+        "no-undefined": ["off"],
+        "array-bracket-newline": ["error", "consistent"],
+        "brace-style": ["error", "1tbs", {
+            "allowSingleLine": false
+        }],
+        "comma-spacing": ["error", {
+            "before": false,
+            "after": true
+        }],
+        "comma-style": ["error", "last"],
+        "comma-dangle": ["error", "never"],
+        "no-var": ["error"],
+        "import/order": ["error", {
+            "groups": ["builtin", "external","internal", "parent", "sibling", "index", "type", "object", "unknown"],
+            "warnOnUnassignedImports": true
+        }],
+        "node/file-extension-in-import": ["error", "always", {
+            "tryExtensions": [".js", ".json"]
+        }],
+        "newline-per-chained-call": ["error", {
+            "ignoreChainWithDepth": 2
+        }],
+        "no-confusing-arrow": ["error"],
+        "no-const-assign": ["error"],
+        "no-duplicate-imports": ["error", {
+            "includeExports": true
+        }],
+        "camelcase": ["warn"],
+        "jsx-quotes": ["warn"],
+        "yoda": ["error", "never", {
+            "exceptRange": true
+        }],
+        "no-eval": ["error"],
+        "array-callback-return": ["error"],
+        "valid-jsdoc": ["error", {
+            "requireParamType": true,
+            "requireReturnType": true,
+            "requireReturn": false,
+            "requireParamDescription": false,
+            "requireReturnDescription": false
+        }],
+        "no-empty": ["error", {
+            "allowEmptyCatch": true
+        }],
+        "keyword-spacing": ["warn"],
+        "space-infix-ops": ["warn"],
+        "spaced-comment": ["warn", "always"],
+        "eol-last": ["warn", "always"],
+        "max-len": ["warn", {
+            "code": 140,
+            "tabWidth": 4,
+            "ignoreStrings": true
+        }]
+    }
+}

.gitattributes

@@ -0,0 +1,9 @@
+*.ico filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+*.woff filter=lfs diff=lfs merge=lfs -text
+*.woff2 filter=lfs diff=lfs merge=lfs -text
+*.afdesign filter=lfs diff=lfs merge=lfs -text
+*.ai filter=lfs diff=lfs merge=lfs -text

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,32 @@
+### Description of change
+
+<!--
+  Please be clear and concise what the change is intended to do,
+  why this change is needed, and how you've verified that it
+  corrects what you intended to correct.
+
+  In some cases, it may be helpful to include the current behavior
+  and the new behavior.
+
+  If the change is related to an open issue, you can link it here.
+  If you include `Fixes #0000` (replacing `0000` with the issue number)
+  when this is merged, it will automatically mark the issue as fixed and
+  close it.
+-->
+
+
+### Pull-Request Checklist
+
+<!--
+  Please make sure to review and check all the following items:
+
+  If an item is not applicable, you can add "N/A" to the end.
+-->
+
+- [ ] Code is up-to-date with the `master` branch
+- [ ] `npm run format` to apply prettier formatting
+- [ ] `npm run test` passes with this change
+- [ ] This pull request links relevant issues as `Fixes #0000`
+- [ ] There are new or updated unit tests validating the change
+- [ ] Documentation has been updated to reflect this change
+- [ ] The new commits follow conventions explained in [CONTRIBUTING.md](https://github.com/giladgd/typeorm-codebase-sync/blob/master/CONTRIBUTING.md)

.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "17"
+      - name: Install modules
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: Test
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "17"
+      - name: Install modules
+        run: npm ci
+      - name: ESLint
+        run: npx eslint --ext .js --ext .ts .
+      - name: TypeScript validity
+        run: npm run test:typescript
+      - name: Coverage
+        run: npx c8 mocha

.gitignore

@@ -0,0 +1,13 @@
+/.idea
+/.vscode
+/.history
+
+node_modules
+npm-debug.log*
+.DS_Store
+
+/coverage
+/.nyc_output
+
+/dist
+/tsconfig.tsbuildinfo

.gitlab-ci.yml

@@ -0,0 +1,34 @@
+image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/node:17.7
+
+stages:
+  - test
+  - release
+
+
+test:
+  stage: test
+  script:
+    - npm ci
+
+    - mkdir -p ci
+
+    - npx eslint --ext .js --ext .ts .
+    - npm run test:typescript
+    - npx c8 --reporter cobertura mocha
+  needs: []
+  artifacts:
+    reports:
+      cobertura: coverage/cobertura-coverage.xml
+
+release:
+  stage: release
+  script:
+    - npm ci
+
+    - npm run build
+    - npx semantic-release
+  needs:
+    - test
+  only:
+    refs:
+      - master

.mochaSetup.ts

@@ -0,0 +1,5 @@
+import chai from "chai";
+import chaiAsPromised from "chai-as-promised";
+
+chai.should();
+chai.use(chaiAsPromised);