typeorm-naming-strategy 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## 1.0.0 (2021-12-17)
+
+
+### Bug Fixes
+
+* :beer: fixed eslint run ([14c919e](https://github.com/chantouchsek/typeorm-naming-strategy/commit/14c919e4899b482b51dfff0e418ab97db1021e8d))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Chantouch Sek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# Typeorm naming strategy
+
+[![ci](https://github.com/chantouchsek/typeorm-naming-strategy/actions/workflows/test.yml/badge.svg)](https://github.com/chantouchsek/typeorm-naming-strategy/actions/workflows/test.yml)
+[![Latest Version on NPM](https://img.shields.io/npm/v/typeorm-naming-strategy.svg?style=flat-square)](https://npmjs.com/package/typeorm-naming-strategy)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
+[![npm](https://img.shields.io/npm/dt/typeorm-naming-strategy.svg?style=flat-square)](https://npmjs.com/package/typeorm-naming-strategy)
+[![npm](https://img.shields.io/npm/dm/typeorm-naming-strategy.svg?style=flat-square)](https://npmjs.com/package/typeorm-naming-strategy)
+
+This package provides a few (one, at the moment) useful custom naming strategies. It alliterates the name of columns, relations, and other fields in the database.
+
+For example, using the snake strategy, if you have a model like this:
+
+```typescript
+class User {
+  @Column()
+  createdAt;
+}
+```
+
+In the DB the `createdAt` field will be `created_at`
+
+## Naming strategies available
+
+- Snake
+
+## Installation
+
+It's available as an [npm package](https://www.npmjs.com/package/typeorm-naming-strategy)
+
+```sh
+npm install typeorm-naming-strategy --save
+```
+
+Or using yarn
+
+```sh
+yarn add typeorm-naming-strategy
+```
+
+## Usage
+
+```ts
+import { createConnection } from 'typeorm';
+// import { SnakeNamingStrategy } from 'typeorm-naming-strategy';
+import SnakeNamingStrategy from 'typeorm-naming-strategy';
+
+await createConnection({
+  ...
+  namingStrategy: new SnakeNamingStrategy(), // Here you'r using the strategy!
+});
+```
+
+Alternatively you can use it in combination with a `ormconfig.js`
+
+```js
+// Use require instead of import
+// const SnakeNamingStrategy = require("typeorm-naming-strategy").SnakeNamingStrategy
+const SnakeNamingStrategy = require("typeorm-naming-strategy")
+
+module.exports = {
+  ...
+  namingStrategy: new SnakeNamingStrategy(),
+}
+```
+
+Or you can use it in combination with a `ormconfig.ts`
+
+```ts
+import SnakeNamingStrategy from 'typeorm-naming-strategy';
+
+module.exports = {
+  ...
+  namingStrategy: new SnakeNamingStrategy(),
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { SnakeNamingStrategy } from './snake-naming.strategy';
+export { SnakeNamingStrategy };
+export default SnakeNamingStrategy;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnakeNamingStrategy = void 0;
+const snake_naming_strategy_1 = require("./snake-naming.strategy");
+Object.defineProperty(exports, "SnakeNamingStrategy", { enumerable: true, get: function () { return snake_naming_strategy_1.SnakeNamingStrategy; } });
+exports.default = snake_naming_strategy_1.SnakeNamingStrategy;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mEAA8D;AAErD,oGAFA,2CAAmB,OAEA;AAE5B,kBAAe,2CAAmB,CAAC"}

package/dist/snake-naming.strategy.d.ts

@@ -0,0 +1,11 @@
+import { DefaultNamingStrategy, NamingStrategyInterface } from 'typeorm';
+export declare class SnakeNamingStrategy extends DefaultNamingStrategy implements NamingStrategyInterface {
+    tableName(className: string, customName: string): string;
+    columnName(propertyName: string, customName: string, embeddedPrefixes: string[]): string;
+    relationName(propertyName: string): string;
+    joinColumnName(relationName: string, referencedColumnName: string): string;
+    joinTableName(firstTableName: string, secondTableName: string, firstPropertyName: string): string;
+    joinTableColumnName(tableName: string, propertyName: string, columnName?: string): string;
+    classTableInheritanceParentColumnName(parentTableName: string, parentTableIdPropertyName: string): string;
+    eagerJoinRelationAlias(alias: string, propertyPath: string): string;
+}

package/dist/snake-naming.strategy.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnakeNamingStrategy = void 0;
+const typeorm_1 = require("typeorm");
+const StringUtils_1 = require("typeorm/util/StringUtils");
+class SnakeNamingStrategy extends typeorm_1.DefaultNamingStrategy {
+    tableName(className, customName) {
+        return customName ? customName : (0, StringUtils_1.snakeCase)(className);
+    }
+    columnName(propertyName, customName, embeddedPrefixes) {
+        return ((0, StringUtils_1.snakeCase)(embeddedPrefixes.concat('').join('_')) +
+            (customName ? customName : (0, StringUtils_1.snakeCase)(propertyName)));
+    }
+    relationName(propertyName) {
+        return (0, StringUtils_1.snakeCase)(propertyName);
+    }
+    joinColumnName(relationName, referencedColumnName) {
+        return (0, StringUtils_1.snakeCase)(relationName + '_' + referencedColumnName);
+    }
+    joinTableName(firstTableName, secondTableName, firstPropertyName) {
+        return (0, StringUtils_1.snakeCase)(firstTableName +
+            '_' +
+            firstPropertyName.replace(/\./gi, '_') +
+            '_' +
+            secondTableName);
+    }
+    joinTableColumnName(tableName, propertyName, columnName) {
+        return (0, StringUtils_1.snakeCase)(tableName + '_' + (columnName ? columnName : propertyName));
+    }
+    classTableInheritanceParentColumnName(parentTableName, parentTableIdPropertyName) {
+        return (0, StringUtils_1.snakeCase)(`${parentTableName}_${parentTableIdPropertyName}`);
+    }
+    eagerJoinRelationAlias(alias, propertyPath) {
+        return alias + '_' + propertyPath.replace('.', '_');
+    }
+}
+exports.SnakeNamingStrategy = SnakeNamingStrategy;
+//# sourceMappingURL=snake-naming.strategy.js.map

package/dist/snake-naming.strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snake-naming.strategy.js","sourceRoot":"","sources":["../src/snake-naming.strategy.ts"],"names":[],"mappings":";;;AAAA,qCAAyE;AACzE,0DAAqD;AAErD,MAAa,mBACX,SAAQ,+BAAqB;IAG7B,SAAS,CAAC,SAAiB,EAAE,UAAkB;QAC7C,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,uBAAS,EAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,UAAU,CACR,YAAoB,EACpB,UAAkB,EAClB,gBAA0B;QAE1B,OAAO,CACL,IAAA,uBAAS,EAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChD,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,uBAAS,EAAC,YAAY,CAAC,CAAC,CACpD,CAAC;IACJ,CAAC;IAED,YAAY,CAAC,YAAoB;QAC/B,OAAO,IAAA,uBAAS,EAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IAED,cAAc,CAAC,YAAoB,EAAE,oBAA4B;QAC/D,OAAO,IAAA,uBAAS,EAAC,YAAY,GAAG,GAAG,GAAG,oBAAoB,CAAC,CAAC;IAC9D,CAAC;IAED,aAAa,CACX,cAAsB,EACtB,eAAuB,EACvB,iBAAyB;QAEzB,OAAO,IAAA,uBAAS,EACd,cAAc;YACZ,GAAG;YACH,iBAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;YACtC,GAAG;YACH,eAAe,CAClB,CAAC;IACJ,CAAC;IAED,mBAAmB,CACjB,SAAiB,EACjB,YAAoB,EACpB,UAAmB;QAEnB,OAAO,IAAA,uBAAS,EACd,SAAS,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAC3D,CAAC;IACJ,CAAC;IAED,qCAAqC,CACnC,eAAuB,EACvB,yBAAiC;QAEjC,OAAO,IAAA,uBAAS,EAAC,GAAG,eAAe,IAAI,yBAAyB,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,sBAAsB,CAAC,KAAa,EAAE,YAAoB;QACxD,OAAO,KAAK,GAAG,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACtD,CAAC;CACF;AA7DD,kDA6DC"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "typeorm-naming-strategy",
+  "version": "1.0.0",
+  "description": "Custom naming strategies for typeorm",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": "^12.20.0 || >=14.13.0"
+  },
+  "keywords": [
+    "typeorm",
+    "naming",
+    "strategy",
+    "node",
+    "orm",
+    "naming strategy",
+    "snake strategy",
+    "typeorm snake",
+    "naming strategies"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/chantouchsek/typeorm-naming-strategy"
+  },
+  "author": {
+    "name": "Chantouch Sek",
+    "email": "chantouchsek.cs83@gmail.com",
+    "url": "https://chantouch.me"
+  },
+  "lint-staged": {
+    "*.{ts,js}": "eslint"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "test": "jest --coverage --passWithNoTests --bail",
+    "prepublish": "yarn build",
+    "prepare": "husky install",
+    "lint": "eslint --ext \".ts,.js,.vue\" --ignore-path .gitignore .",
+    "standard-version": "standard-version",
+    "release": "standard-version && git push --follow-tags origin main && yarn publish"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
+    "@types/jest": "^27.0.3",
+    "@types/node": "^17.0.0",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.31.1",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "husky": "^7.0.4",
+    "jest": "^27.4.5",
+    "lint-staged": "^12.1.2",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.2",
+    "standard-version": "^9.3.2",
+    "ts-jest": "^27.1.2",
+    "tslint": "^6.1.3",
+    "typeorm": "^0.2.41",
+    "typescript": "^4.5.4"
+  },
+  "peerDependencies": {
+    "typeorm": "^0.2.41"
+  }
+}