sync (#13)

Author: LukasPolak

Diff for: .gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

Diff for: .github/workflows/main.yml

@@ -12,15 +12,23 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Cancel previous runs
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
+        uses: bahmutov/npm-install@v1
+        with:
+          useLockFile: false
 
-      - name: Building the library
+      - name: Build the library
         run: yarn build
 
-      - name: Testing the library
+      - name: Test the library
         run: yarn test:coverage
 
       - name: Codecov

Diff for: .npmrc

@@ -0,0 +1 @@
+package-lock=false

Diff for: CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement. All complaints
+will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

Diff for: .github/CONTRIBUTING.md renamed to CONTRIBUTING.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2021 Artem Zakharchenko
+
+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: LICENSE.md

@@ -61,3 +61,5 @@ Also update `tsconfig.json` file with:
   // ...
 }
 ```
+
+Please read the [Contribution guidelines](CONTRIBUTING.md) to start with your awesome contributions!

Diff for: README.md

@@ -0,0 +1,50 @@
+import * as fs from 'fs'
+import * as path from 'path'
+import * as packageJson from './package.json'
+
+describe('Distribution', () => {
+  it('Name and description', () => {
+    expect(packageJson).toHaveProperty('name')
+    expect(packageJson).toHaveProperty('description')
+  })
+
+  it('Main entry point', () => {
+    expect(fs.existsSync(packageJson.main)).toBe(true)
+  })
+
+  it('Type definitions', () => {
+    expect(fs.existsSync(packageJson.types)).toBe(true)
+  })
+})
+
+describe('Community', () => {
+  it('README', () => {
+    const filenames = ['README', 'README.md']
+    expect(filenames.some(fs.existsSync)).toBe(true)
+  })
+
+  it('Code of conduct', () => {
+    const filenames = ['CODE_OF_CONDUCT', 'CODE_OF_CONDUCT.md']
+    expect(filenames.some(fs.existsSync)).toBe(true)
+  })
+
+  it('Contributing guidelines', () => {
+    const filenames = ['CONTRIBUTING', 'CONTRIBUTING.md']
+    const locations = ['.', '.github']
+
+    expect(
+      filenames.some((filename) => {
+        return locations.some((location) => {
+          return fs.existsSync(path.resolve(location, filename))
+        })
+      })
+    )
+  })
+
+  it('License', () => {
+    expect(packageJson).toHaveProperty('license')
+
+    const filenames = ['LICENSE', 'LICENSE.md']
+    expect(filenames.some(fs.existsSync)).toBe(true)
+  })
+})

Diff for: STANDARDS.ts

@@ -4,6 +4,6 @@ import { compilerOptions } from './tsconfig.json'
 export default {
   preset: 'ts-jest',
   moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, {
-    prefix: '<rootDir>/',
+    prefix: '<rootDir>',
   }),
 }

Diff for: jest.config.ts

@@ -20,10 +20,11 @@
     "format": "prettier --write .",
     "hygen:file": "hygen file new",
     "lint": "eslint ./{src,test}/**/*.ts",
-    "prepublishOnly": "yarn build && yarn test",
+    "prepublishOnly": "yarn build && yarn test:lib && yarn test",
     "start": "rollup -c rollup.config.ts -w",
     "test": "jest",
     "test:coverage": "jest --collectCoverage",
+    "test:lib": "jest STANDARDS.ts --testRegex=\"(STANDARDS\\.ts)\"",
     "test:silent": "jest --silent",
     "test:watch": "jest --watch",
     "preversion": "yarn build && yarn test",
@@ -38,8 +39,8 @@
   },
   "lint-staged": {
     "*.ts": [
-      "eslint",
-      "prettier"
+      "prettier --write",
+      "eslint --fix"
     ]
   },
   "prettier": "@lukaspolak/prettier-config",
@@ -68,5 +69,8 @@
     "ts-jest": "^26.5.0",
     "ts-node": "^9.1.1",
     "typescript": "^4.1.3"
+  },
+  "engines": {
+    "node": ">= 14.15.1"
   }
 }