Merge pull request #1 from davidchin/add_function

CHECKOUT-4272: Add `memoize` function

Author: davidchin

.circleci/config.yml

@@ -0,0 +1,44 @@
+version: 2.1
+
+orbs:
+  ci: bigcommerce/internal@volatile
+  node: bigcommerce/internal-node@volatile
+
+jobs:
+  build:
+    executor:
+      name: node/node
+      node-version: "10"
+
+    steps:
+      - ci/pre-setup
+
+      - restore_cache:
+          keys:
+            - memoize-js
+
+      - run: npm ci
+
+      - save_cache:
+          key: memoize-js
+          paths:
+            - ~/.npm
+
+      - run:
+          name: Test
+          command: npm run test:series -- --coverage
+          when: always
+
+      - store_artifacts:
+          path: coverage
+          destination: coverage
+
+      - run:
+          name: Lint
+          command: npm run lint
+          when: always
+
+      - run:
+          name: Validate commits
+          command: npm run validate-commits
+          when: always

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+## What?
+...
+
+## Why?
+...
+
+## Testing / Proof
+...
+
+@bigcommerce/frontend

.gitignore

@@ -0,0 +1,4 @@
+*.log
+/coverage
+/lib
+/node_modules

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+## Issues / Bugs
+ 
+* Please include a clear, specific title and replicable description.
+
+* Please include your environment, OS, and any exceptions/backtraces that occur. The more
+information that is given, the more likely we can debug and fix the issue.
+
+**If you find a security bug, please do not post as an issue. Send directly to [email protected] 
+instead.**

LICENSE.md

@@ -0,0 +1,9 @@
+(The MIT License)
+Copyright (C) 2018-Present BigCommerce Inc. 
+All rights reserved.
+
+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.

README.md

@@ -1 +1,50 @@
+# @bigcommerce/memoize
 
+This library can be used to memoize the result of a pure function. 
+
+Unlike the default `memoize` function provided by Lodash, it can be applied to functions that accept multiple non-primitive arguments. It can also be configured to expire its cache after certain number of unique calls. By default, it compares object-based arguments shallowly; but it can be configured to compare arguments strictly or deeply depending on your usage requirement.
+
+
+## Install
+
+You can install this library using [npm](https://www.npmjs.com/get-npm).
+
+```sh
+npm install --save @bigcommerce/memoize
+```
+
+
+## Usage
+
+To memoize a function
+
+```ts
+function fn(a, b) {
+    return { a, b };
+}
+
+const memoizedFn = memoize(fn);
+const result = memoizedFn({ message: 'hello' }, { message: 'world' });
+const result2 = memoizedFn({ message: 'hello' }, { message: 'world' });
+
+expect(result).toBe(result2);
+```
+
+
+## Contribution
+
+To release:
+
+```sh
+npm run release
+```
+
+To see other available commands:
+
+```sh
+npm run
+```
+
+## License
+
+MIT

commit-validation.json

@@ -0,0 +1,6 @@
+{
+    "scopes": [
+        "common",
+        "core"
+    ]
+}

jest-config.js

@@ -0,0 +1,19 @@
+module.exports = {
+    browser: true,
+    preset: 'ts-jest',
+    moduleFileExtensions: [
+        'ts',
+        'tsx',
+        'js',
+        'jsx',
+        'json',
+    ],
+    setupTestFrameworkScriptFile: '<rootDir>/jest-setup.ts',
+    collectCoverageFrom: [
+        'src/**/*.ts',
+    ],
+    coveragePathIgnorePatterns: [
+        '\\.mock\\.ts$',
+        '\\.d\\.ts$',
+    ],
+};

jest-setup.ts

@@ -0,0 +1,3 @@
+beforeAll(() => {
+    expect.hasAssertions();
+});