Deep copy object

Deep copy object is a small JavaScript utility to deeply copy an object. Subtypes of object (such as arrays, funcitons or Date) are not copied.

Table of contents

• Table of contents
• Getting started
  • Prerequisites
  • Installation
  • Running the project for development
• Usage
  • Starting the project
  • Building the project
  • Running the tests
  • Code formatting and linting
• Built with
• License

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• NPM

Installation requires NPM which is included with Node. You can install Node by downloading the installer from the website.

To update NPM to the latest version:

npm install -g npm@latest

Installation

1. Clone the repo

git clone https://github.com/sargalias/deep-copy-obj.git

2. Install NPM packages

npm install

Running the project for development

npm start

Usage

Starting the project

• Start the project on a local server: npm start

Building the project

• Build the project for production: npm run build
• Build the project for development (linting errors won't fail the build): npm run build:dev
• Run the build in watch mode: npm run build:watch

Running the tests

• Run Jest tests with coverage: npm test
• Run Jest tests without coverage: npm run test:no-coverage
• Run Jest tests in watch mode: npm run test:watch

Code formatting and linting

• Format code with Prettier code formatter: npm run format
• Run lint check: npm run lint
• Run lint check in fix mode: npm run lint:fix

Built with

• Webpack - To bundle code
  • webpack-merge - To help us create multiple webpack configs
  • clean-webpack-plugin - To clean the destination directory for every build
  • eslint-loader - For using ESLint with webpack
• Jest - Test framework
  • jest-extended - More awesome assertions for Jest
  • jest-each - Compact way to run the same test with multiple inputs
  • ts-jest - Allows you to use TypScript in your jest tests
• ESLint - JavaScript static code analysis
  • eslint-config-airbnb-base - Aribnb's base .eslintrc
  • eslint-config-prettier - For using Prettier with ESLint
  • eslint-plugin-import - Helps validate proper imports
  • eslint-plugin-import-resolver-webpack - Import resolver for webpack
  • eslint-plugin-jest - Rules and globals for Jest
  • eslint-plugin-prettier - Runs prettier as an ESLint rule
  • @typescript-eslint/parser - Allows ESLint to work with TS files
• Babel - To transpile code
  • @babel/preset-env - To transpile code in tests
  • babel-jest - For Jest to transpile code
• Prettier - Code formatting
• TypeScript - Types for JavaScript
• And lots of types from the DefinitelyTyped project

License

This project is licensed under the MIT License - see the LICENSE.md file for details.