Skip to content

Commit

Permalink
Initialize Empty Package (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
finn-orsini committed Apr 29, 2022
1 parent 19af869 commit 5ac733d
Show file tree
Hide file tree
Showing 24 changed files with 3,086 additions and 279 deletions.
13 changes: 13 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module.exports = {
"env": {
"commonjs": true,
"es2021": true,
"node": true
},
"extends": "eslint:recommended",
"parserOptions": {
"ecmaVersion": "latest"
},
"rules": {
}
}
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md

This file was deleted.

54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: 🐞 Bug
description: Report a bug/issue
title: "[BUG] <title>"
labels: [Bug, Needs Triage]
body:
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior. Ideally provide a minimal reproduction repo.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **Node Version**: 13.14.0
- **Package Manager**: yarn
- **Package Manager Version**: 2.3.1
value: |
- OS:
- Node Version:
- Package Manager:
- Package Manager Version:
render: markdown
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

This file was deleted.

28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Feature Request
description: Suggest a feature for this project
title: "[Feat] <title>"
body:
- type: textarea
attributes:
label: Problem Statement
description: A clear and concise description of what you want and what your use case is.
validations:
required: true
- type: textarea
attributes:
label: Proposed Solution
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Alternatives Considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
attributes:
label: Additional Context
description: Please provide any other information that may be relevant.
validations:
required: false
17 changes: 3 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Description
<!-- Please check the contributing guide before entering PRs: https://github.com/wayfair-incubator/one-version/blob/main/CONTRIBUTING.md -->

Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to related issues, other PRs, or technical references.
## Description

Note that by _not_ including a description, you are asking reviewers to do extra work to understand the context of this change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all.
<!-- Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to related issues, other PRs, or technical references.-- >
## Type of Change
Expand All @@ -12,14 +12,3 @@ Note that by _not_ including a description, you are asking reviewers to do extra
- [ ] Refactor
- [ ] Documentation
- [ ] Other (please describe)

## Checklist

<!-- TODO: Update the link below to point to your project's contributing guidelines -->
- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/oss-template/blob/main/CONTRIBUTING.md)
- [ ] Existing issues have been referenced (where applicable)
- [ ] I have verified this change is not present in other open pull requests
- [ ] Functionality is documented
- [ ] All code style checks pass
- [ ] New code contribution is covered by automated tests
- [ ] All new and existing tests pass
21 changes: 0 additions & 21 deletions .github/workflows/lint.yml

This file was deleted.

73 changes: 73 additions & 0 deletions .github/workflows/pr-checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: PR Checks

on: # Rebuild any PRs and main branch changes
push:
branches:
- main
pull_request:


jobs:

install-node-modules:
name: Install Dependencies
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 12.x
cache: yarn
- name: Validate cache
run: yarn install --frozen-lockfile

test:
name: Run Jest Tests
runs-on: ubuntu-latest
needs: install-node-modules

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 12.x
cache: yarn
- name: install
run: yarn install --frozen-lockfile
- name: test
run: yarn test

lint:
name: Run Lints
runs-on: ubuntu-latest
needs: install-node-modules

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 12.x
cache: yarn
- name: install
run: yarn install --frozen-lockfile
- name: lint
run: yarn lint
- name: markdown lint
run: yarn lint:md

prettier:
name: Check Formatting
runs-on: ubuntu-latest
needs: install-node-modules

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 12.x
cache: yarn
- name: install
run: yarn install --frozen-lockfile
- name: format-check
run: yarn format:check
24 changes: 24 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: "publish to NPM"
on:
push:
tags: ["*"]

jobs:
publish:
runs-on: "ubuntu-latest"
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: 12
- run: yarn
- run: yarn test

- id: "publish"
uses: JS-DevTools/npm-publish@v1
with:
token: ${{ secrets.NPM_AUTH_TOKEN }}

- if: steps.publish.outputs.type != 'none'
run: |
echo "Published new version: ${{ steps.publish.outputs.old-version }} => ${{ steps.publish.outputs.version }}"
50 changes: 50 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Logs
logs
*.log
npm-debug.log*

# OS
.DS_Store

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directory
node_modules

# Yarn directory
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions

# Optional REPL history
.node_repl_history

# output directory
dist

TODO
coverage
lib
_compiled_tests
24 changes: 13 additions & 11 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
{
"default": true,
"MD013": {
"line_length": 10000,
"headings": false,
"code_blocks": false,
"tables": false
},
"MD024": {
"siblings_only": true
},
"MD041": false
"default": true,
"MD013": {
"line_length": 10000,
"headings": false,
"code_blocks": false,
"tables": false
},
"MD024": {
"siblings_only": true
},
"MD041": false,
"MD033": false,
"MD001": false
}
6 changes: 6 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package.json
.github
.yarn
dist
*.md
coverage
1 change: 1 addition & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 1 addition & 0 deletions .yarnrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
registry "https://registry.npmjs.org/"
Loading

0 comments on commit 5ac733d

Please sign in to comment.