first commit

Author: Kevin Hermawan

.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: './tsconfig.json',
+  },
+  plugins: ['prettier', '@typescript-eslint'],
+  rules: {},
+};

.github/workflows/code-quality.yml

@@ -0,0 +1,55 @@
+name: Code Quality
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Run unit test
+        run: npm run test:coverage
+
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build package
+        run: npm run build

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: https://registry.npmjs.org
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build package
+        run: npm run build
+
+      - name: Release package
+        run: npm publish --verbose --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+coverage
+dist
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx commitlint --edit 

.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  semi: true,
+  singleQuote: true,
+  bracketSameLine: false,
+  trailingComma: 'es5',
+};

README.md

@@ -0,0 +1,158 @@
+# Enhanced Array
+
+A collection of common utilities for the JavaScript array.
+
+> This library copies common utilities from other languages. For advanced utilities, please use a library like Lodash instead.
+
+## Installation
+
+```
+npm i enhanced-array
+```
+
+Only need a few? Just copy the source code :)
+
+## API
+
+### Accessing Elements
+
+#### [getFirst](/src/getFirst.ts)
+
+Returns the first element of the array.
+
+```ts
+import { getFirst } from 'enhanced-array';
+
+const result = getFirst([1, 2, 3, 4, 5]);
+console.log(result); // 1
+```
+
+> **Time complexity:**
+>
+> O(1)
+
+#### [getLast](/src/getLast.ts)
+
+Returns the last element of the array.
+
+```ts
+import { getLast } from 'enhanced-array';
+
+const result = getLast([1, 2, 3, 4, 5]);
+console.log(result); // 5
+```
+
+> **Time complexity:**
+>
+> O(1)
+
+---
+
+### Adding Elements
+
+#### [insertAt](/src/insertAt.ts)
+
+Inserts a new element at the specified position.
+
+```ts
+import { insertAt } from 'enhanced-array';
+
+const result = insertAt([1, 2, 3, 4, 5], { index: 3, element: 9 });
+console.log(result); // [1, 2, 3, 9, 4, 5]
+```
+
+> **Time complexity:**
+>
+> O(n), where n is the length of the array.
+>
+> O(1), if `index` is the last index of the array.
+
+---
+
+### Inspecting Elements
+
+#### [isContainNil](/src/isContainNil.ts)
+
+Returns a boolean that indicates whether the array contains `undefined` or `null`.
+
+```ts
+import { isContainNil } from 'enhanced-array';
+
+const result1 = isContainNil([1, 2, 3, 4, 5]);
+console.log(result1); // false
+
+const result2 = isContainNil([1, 2, undefined, 4, 5]);
+console.log(result2); // true
+
+const result3 = isContainNil([1, 2, null, 4, 5]);
+console.log(result3); // true
+```
+
+> **Time complexity:**
+>
+> O(n), where n is the length of the array.
+>
+> O(1), if `index` is the last index of the array.
+
+#### [isEmpty](/src/isEmpty.ts)
+
+Returns a boolean that indicates whether the array is empty.
+
+```ts
+import { isEmpty } from 'enhanced-array';
+
+const result1 = isEmpty([1, 2, 3, 4, 5]);
+console.log(result1); // false
+
+const result2 = isEmpty([]);
+console.log(result2); // true
+```
+
+> **Time complexity:**
+>
+> O(1)
+
+---
+
+### Removing Elements
+
+#### [removeAt](/src/removeAt.ts)
+
+Removes the element at the specified position.
+
+```ts
+import { removeAt } from 'enhanced-array';
+
+const result = removeAt([1, 2, 3, 4, 5], { index: 3 });
+console.log(result); // [1, 2, 3, 5]
+```
+
+> **Time complexity:**
+>
+> O(n), where n is the length of the array.
+>
+> O(1), if `index` is the last index of the array.
+
+---
+
+### Reordering Elements
+
+#### [swap](/src/swap.ts)
+
+Exchanges the element at the specified indices of the array.
+
+```ts
+import { swap } from 'enhanced-array';
+
+const result = swap([1, 2, 3, 4, 5], { i: 0, j: 4 });
+
+console.log(result); // [5, 2, 3, 4, 1]
+```
+
+> **Time complexity:**
+>
+> O(1)
+
+## Stolen From
+
+- [Swift's Array](https://developer.apple.com/documentation/swift/array)

commitlint.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'subject-empty': [0],
+    'type-enum': [
+      2,
+      'always',
+      ['chore', 'feat', 'fix', 'test', 'docs', 'refactor', 'revert', 'release'],
+    ],
+  },
+};