Create library

Author: rozsival

Diff for: .coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+json_path: temp/coveralls.json

Diff for: .eslintignore

@@ -0,0 +1,3 @@
+/.history
+/dist
+/node_modules

Diff for: .eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  extends: require.resolve('@wavevision/coding-standard/ts/eslint/base'),
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: '.',
+  },
+};

Diff for: .gitignore

@@ -0,0 +1,9 @@
+*.log
+/.history
+/.idea
+!/.idea/codeStyles/codeStyleConfig.xml
+!/.idea/codeStyles/Project.xml
+/dist
+/node_modules
+/temp
+/.eslintcache

Diff for: .npmrc

@@ -0,0 +1 @@
+scripts-prepend-node-path=true

Diff for: .nvmrc

@@ -0,0 +1 @@
+12.13.0

Diff for: .prettierignore

@@ -0,0 +1,3 @@
+/.history
+/dist
+/node_modules

Diff for: .travis.yml

@@ -0,0 +1,16 @@
+os: linux
+dist: xenial
+
+cache:
+  yarn: true
+  directories:
+    - node_modules
+
+git:
+  depth: 1
+
+language: node_js
+
+jobs:
+  include:
+    - script: yarn ci

Diff for: LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Wavevision s.r.o.
+
+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.

Diff for: jest.config.js

@@ -0,0 +1,20 @@
+module.exports = {
+  globals: {
+    'ts-jest': {
+      isolatedModules: true,
+    },
+  },
+  testMatch: ['<rootDir>/src/**/tests/*.test.ts'],
+  testPathIgnorePatterns: ['<rootDir>/node_modules'],
+  moduleDirectories: ['node_modules', 'src'],
+  moduleFileExtensions: ['js', 'ts'],
+  coverageDirectory: '<rootDir>/temp/coverage',
+  coverageReporters: ['html', 'lcov', 'text'],
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/index.ts',
+    '!src/**/*.test.ts',
+    '!**/node_modules/**',
+  ],
+  preset: 'ts-jest',
+};

Diff for: package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@wavevision/ts-utils",
+  "version": "0.1.0",
+  "description": "Useful TypeScript utilities and helpers",
+  "keywords": [
+    "typescript",
+    "utilities"
+  ],
+  "main": "index.js",
+  "author": "Wavevision s.r.o. <[email protected]>",
+  "contributors": [
+    {
+      "name": "Vít Rozsíval",
+      "email": "[email protected]"
+    }
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wavevision/ts-utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wavevision/ts-utils/issues"
+  },
+  "homepage": "https://github.com/wavevision/ts-utils",
+  "devDependencies": {
+    "@types/jest": "^24.0.25",
+    "@types/react": "^16.9.17",
+    "@typescript-eslint/eslint-plugin": "^2.15.0",
+    "@typescript-eslint/parser": "^2.15.0",
+    "@wavevision/coding-standard": "^2.1.6",
+    "coveralls": "^3.0.9",
+    "eslint": "^6.8.0",
+    "jest": "^24.9.0",
+    "npm-run-all": "^4.1.5",
+    "react": "^16.12.0",
+    "ts-jest": "^24.3.0",
+    "typescript": "^3.7.4"
+  },
+  "scripts": {
+    "build": "NODE_ENV=production run-s clean ts:build",
+    "ci": "run-s ts eslint prettier test:coverage:report",
+    "clean": "rm -rf dist/*",
+    "eslint": "eslint src --cache --ext .ts",
+    "eslint:fix": "yarn eslint --fix",
+    "fix": "run-s ts eslint:fix prettier:fix test",
+    "postversion": "run-s postversion:push:tags postversion:publish postversion:push postversion:echo",
+    "postversion:echo": "echo \"Successfully released version $npm_package_version!\"",
+    "postversion:publish": "yarn publish --access public --new-version $npm_package_version",
+    "postversion:push": "git push",
+    "postversion:push:tags": "yarn postversion:push --tags",
+    "prettier": "prettier '**/*.ts' --check",
+    "prettier:fix": "yarn prettier --write",
+    "prepare": "npm run build",
+    "preversion": "run-s fix build",
+    "test": "jest",
+    "test:coverage": "jest --coverage || true",
+    "test:coverage:report": "jest --coverage && cat temp/coverage/lcov.info | coveralls",
+    "ts": "tsc",
+    "ts:build": "yarn ts --project tsconfig.build.json"
+  }
+}

Diff for: prettier.config.js

@@ -0,0 +1 @@
+module.exports = require('@wavevision/coding-standard/ts/prettier');

Diff for: src/components/getName.ts

@@ -0,0 +1,4 @@
+const getName = <T>(c: import('react').ComponentType<T>): string =>
+  c.displayName || c.name || 'Component';
+
+export default getName;

Diff for: src/components/index.ts

@@ -0,0 +1 @@
+export { default as getName } from './getName';

Diff for: src/components/tests/getName.test.ts

@@ -0,0 +1,11 @@
+import getName from '../getName';
+
+describe('ts-utils/components/getName', () => {
+  it('returns component displayName', () => {
+    const Test = (): null => null;
+    expect(getName(Test)).toBe('Test');
+  });
+  it('returns fallback name for unknown component', () => {
+    expect(getName(() => null)).toBe('Component');
+  });
+});

Diff for: src/index.ts

@@ -0,0 +1,4 @@
+export * from './components';
+export * from './numbers';
+export * from './strings';
+export * from './type';

Diff for: src/numbers/index.ts

@@ -0,0 +1,4 @@
+export { default as makeId } from './makeId';
+export { default as toFixed } from './toFixed';
+export { default as toFixedCelled } from './toFixedCelled';
+export { default as toFixedRounded } from './toFixedRounded';

Diff for: src/numbers/makeId.ts

@@ -0,0 +1,3 @@
+const makeId = (): number => Math.floor(new Date().valueOf() * Math.random());
+
+export default makeId;

Diff for: src/numbers/tests/makeId.test.ts

@@ -0,0 +1,7 @@
+import makeId from '../makeId';
+
+describe('ts-utils/numbers/makeId', () => {
+  it('returns random numeric ID', () => {
+    expect(makeId()).toEqual(expect.any(Number));
+  });
+});

Diff for: src/numbers/tests/toFixed.test.ts

@@ -0,0 +1,13 @@
+import toFixed from '../toFixed';
+
+describe('ts-utils/numbers/toFixed', () => {
+  it('returns float with fixed decimals without rounding', () => {
+    expect(toFixed(1.123)).toBe(1.1);
+    expect(toFixed(5.47826, 3)).toBe(5.478);
+  });
+  it('returns input number', () => {
+    expect(toFixed(22)).toBe(22);
+    expect(toFixed(0, 0)).toBe(0);
+    expect(toFixed(Number.NaN)).toBe(Number.NaN);
+  });
+});

Diff for: src/numbers/tests/toFixedCelled.test.ts

@@ -0,0 +1,8 @@
+import toFixedCelled from '../toFixedCelled';
+
+describe('ts-utils/numbers/toFixedCelled', () => {
+  it('returns float with celled decimals', () => {
+    expect(toFixedCelled(1.023)).toBe(1.1);
+    expect(toFixedCelled(2.4465, 3)).toBe(2.447);
+  });
+});

Diff for: src/numbers/tests/toFixedRounded.test.ts

@@ -0,0 +1,8 @@
+import toFixedRounded from '../toFixedRounded';
+
+describe('ts-utils/numbers/toFixedRounded', () => {
+  it('returns float with rounded decimals', () => {
+    expect(toFixedRounded(1.123)).toBe(1.1);
+    expect(toFixedRounded(5.236, 2)).toBe(5.24);
+  });
+});

Diff for: src/numbers/toFixed.ts

@@ -0,0 +1,7 @@
+const toFixed = (n: number, decimals = 1): number => {
+  const exp = new RegExp(`^-?\\d+(?:.\\d{0,${decimals || -1}})?`);
+  const match = n.toString().match(exp);
+  return match ? parseFloat(match[0]) : n;
+};
+
+export default toFixed;

Diff for: src/numbers/toFixedCelled.ts

@@ -0,0 +1,4 @@
+const toFixedCelled = (n: number, decimals = 1): number =>
+  Number(`${Math.ceil(Number(`${n}e${decimals}`))}e-${decimals}`);
+
+export default toFixedCelled;

Diff for: src/numbers/toFixedRounded.ts

@@ -0,0 +1,4 @@
+const toFixedRounded = (n: number, decimals = 1): number =>
+  Number(n.toFixed(decimals));
+
+export default toFixedRounded;

Diff for: src/strings/camelCaseToDashCase.ts

@@ -0,0 +1,4 @@
+const camelCaseToDashCase = (s: string): string =>
+  s.replace(/([a-zA-Z])(?=[A-Z])/g, '$1-').toLowerCase();
+
+export default camelCaseToDashCase;

Diff for: src/strings/capitalize.ts

@@ -0,0 +1,4 @@
+const capitalize = (s: string): string =>
+  s.charAt(0).toUpperCase() + s.slice(1);
+
+export default capitalize;

Diff for: src/strings/index.ts

@@ -0,0 +1,5 @@
+export { default as camelCaseToDashCase } from './camelCaseToDashCase';
+export { default as capitalize } from './capitalize';
+export { default as random } from './random';
+export { default as shallowStringify } from './shallowStringify';
+export { default as splitCamelCase } from './splitCamelCase';

Diff for: src/strings/random.ts

@@ -0,0 +1,4 @@
+const random = (length = 5): string =>
+  (Math.random() + 1).toString(36).substr(2, length);
+
+export default random;

Diff for: src/strings/shallowStringify.ts

@@ -0,0 +1,4 @@
+const shallowStringify = (object: unknown): string =>
+  JSON.stringify(object, (k, v) => (k ? String(v) : v));
+
+export default shallowStringify;

Diff for: src/strings/splitCamelCase.ts

@@ -0,0 +1,4 @@
+const splitCamelCase = (s: string): Array<string> =>
+  s.split(/(?=[A-Z])/).map(s => s.toLowerCase());
+
+export default splitCamelCase;

Diff for: src/strings/tests/camelCaseToDashCase.test.ts

@@ -0,0 +1,7 @@
+import camelCaseToDashCase from '../camelCaseToDashCase';
+
+describe('ts-utils/strings/camelCaseToDash', () => {
+  it('converts camelcase to dash', () => {
+    expect(camelCaseToDashCase('camelCase')).toBe('camel-case');
+  });
+});

Diff for: src/strings/tests/capitalize.test.ts

@@ -0,0 +1,7 @@
+import capitalize from '../capitalize';
+
+describe('ts-utils/strings/capitalize', () => {
+  it('returns capitalized string', () => {
+    expect(capitalize('hello')).toBe('Hello');
+  });
+});

Diff for: src/strings/tests/random.test.ts

@@ -0,0 +1,8 @@
+import random from '../random';
+
+describe('ts-utils/strings/random', () => {
+  it('generates a random string', () => {
+    expect(random()).toHaveLength(5);
+    expect(random(10)).toHaveLength(10);
+  });
+});

Diff for: src/strings/tests/shallowStringify.test.ts

@@ -0,0 +1,17 @@
+import shallowStringify from '../shallowStringify';
+
+describe('ts-utils/strings/shallowStringify', () => {
+  it('returns stringified object', () => {
+    expect(
+      shallowStringify({
+        prop1: 'value',
+        prop2: true,
+        prop3: {
+          nestedProp1: {
+            nestedProp2: 'value',
+          },
+        },
+      }),
+    ).toBe('{"prop1":"value","prop2":"true","prop3":"[object Object]"}');
+  });
+});

Diff for: src/strings/tests/splitCamelCase.test.ts

@@ -0,0 +1,7 @@
+import splitCamelCase from '../splitCamelCase';
+
+describe('ts-utils/strings/splitCamelCase', () => {
+  it('returns array of lower cased parts', () => {
+    expect(splitCamelCase('someCamelCase')).toEqual(['some', 'camel', 'case']);
+  });
+});

Diff for: src/type/index.ts

@@ -0,0 +1 @@
+export { default as isNil } from './isNil';

Diff for: src/type/isNil.ts

@@ -0,0 +1,4 @@
+const isNil = (n: unknown): n is null | undefined =>
+  n === null || n === undefined;
+
+export default isNil;

Diff for: src/type/tests/isNil.test.ts

@@ -0,0 +1,11 @@
+import isNil from '../isNil';
+
+describe('ts-utils/type/isNil', () => {
+  it('returns true', () => {
+    expect(isNil(null)).toBe(true);
+    expect(isNil(undefined)).toBe(true);
+  });
+  it('returns false', () => {
+    expect(isNil(0)).toBe(false);
+  });
+});

Diff for: tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "noEmit": false,
+    "outDir": "dist"
+  },
+  "exclude": ["./src/**/tests/**/*"]
+}

Diff for: tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@wavevision/coding-standard/ts/tsconfig.json",
+  "compilerOptions": {
+    "allowJs": false,
+    "module": "commonjs",
+    "resolveJsonModule": false,
+    "target": "es5"
+  },
+  "include": ["./*.js", "./src/**/*"]
+}