Skip to content

Commit 136fb8c

Browse files
jorenbroekemajorenbroekema
committed
chore: initial commit
0 parents  commit 136fb8c

File tree

10 files changed

+4336
-0
lines changed

10 files changed

+4336
-0
lines changed

‎.changeset/config.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"linked": [],
6+
"access": "public",
7+
"baseBranch": "master",
8+
"updateInternalDependencies": "patch"
9+
}

‎.github/workflows/release.yml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- '.changeset/*.md'
9+
10+
jobs:
11+
release:
12+
name: Release
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout Repo
16+
uses: actions/checkout@master
17+
with:
18+
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
19+
fetch-depth: 0
20+
21+
22+
- name: Setup Node.js 12.x
23+
uses: actions/setup-node@master
24+
with:
25+
node-version: 12.x
26+
registry-url: 'https://registry.npmjs.org'
27+
28+
- name: Install Dependencies
29+
run: yarn
30+
31+
- name: Changeset version
32+
run: yarn changeset version
33+
34+
- name: Commit version updates
35+
run: |
36+
git config --local user.email "[email protected]"
37+
git config --local user.name "Joren Broekema"
38+
- run: git add .
39+
- run: "git commit -m 'chore: release new versions'"
40+
41+
- name: Release to NPM
42+
env:
43+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
44+
run: yarn changeset publish
45+
46+
- name: Push commits and tags to GitHub
47+
run: git push https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY} --follow-tags

‎.github/workflows/verify.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Verify changes
2+
3+
on: pull_request
4+
5+
jobs:
6+
verify:
7+
name: Verify changes
8+
runs-on: ubuntu-latest
9+
strategy:
10+
matrix:
11+
node-version: [10.x, 13.x]
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: Setup Node ${{ matrix.node-version }}
15+
uses: actions/setup-node@v1
16+
with:
17+
node-version: ${{ matrix.node-version }}
18+
- name: Install dependencies
19+
run: yarn --frozen-lockfile
20+
- name: Lint
21+
run: yarn lint
22+
- name: Test
23+
run: yarn test

‎.gitignore

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## editors
2+
/.idea
3+
/.vscode
4+
5+
## system files
6+
.DS_Store
7+
8+
## code coverage folders
9+
coverage/
10+
11+
## npm
12+
node_modules
13+
npm-debug.log
14+
yarn-error.log
15+
16+
## temp folders
17+
/.tmp/
18+
19+
## we prefer yarn.lock
20+
package-lock.json
21+
## lock files in packages we do not need to save
22+
packages/*/yarn.lock
23+
24+
## build output
25+
dist

‎CODE_OF_CONDUCT.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or
22+
advances of any kind
23+
- Trolling, insulting or derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or email
26+
address, without their explicit permission
27+
- Other conduct which could reasonably be considered inappropriate in a
28+
professional setting
29+
30+
## Enforcement Responsibilities
31+
32+
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.
33+
34+
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.
35+
36+
## Scope
37+
38+
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.
39+
40+
## Enforcement
41+
42+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
43+
44+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45+
46+
## Enforcement Guidelines
47+
48+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49+
50+
### 1. Correction
51+
52+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53+
54+
**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.
55+
56+
### 2. Warning
57+
58+
**Community Impact**: A violation through a single incident or series of actions.
59+
60+
**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.
61+
62+
### 3. Temporary Ban
63+
64+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65+
66+
**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.
67+
68+
### 4. Permanent Ban
69+
70+
**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.
71+
72+
**Consequence**: A permanent ban from any sort of public interaction within the project community.
73+
74+
## Attribution
75+
76+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77+
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78+
79+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80+
81+
[homepage]: https://www.contributor-covenant.org
82+
83+
For answers to common questions about this code of conduct, see the FAQ at
84+
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributing
2+
3+
## Getting Started
4+
5+
> Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
6+
7+
First, create a fork of the [open-wc/open-wc](https://github.com/modernweb-dev/web) repo by hitting the `fork` button on the GitHub page.
8+
9+
Next, clone our repository onto your computer with this command (replacing YOUR_USERNAME with your actual GitHub username)
10+
11+
```sh
12+
git clone [email protected]:modernweb-dev/web.git
13+
```
14+
15+
Once cloning is complete, change directory to the repo.
16+
17+
```sh
18+
cd web
19+
```
20+
21+
Now add your fork as a remote
22+
23+
```sh
24+
git remote add fork [email protected]:<YOUR_NAME>/web.git
25+
```
26+
27+
Create a new local branch
28+
29+
```sh
30+
git checkout -b my-awesome-fix
31+
```
32+
33+
## Preparing Your Local Environment for Development
34+
35+
Now that you have cloned the repository, ensure you have [yarn](https://classic.yarnpkg.com/lang/en/) installed run the following commands to set up the development environment.
36+
37+
```sh
38+
yarn
39+
```
40+
41+
This will download and install all packages needed.
42+
43+
## Making Your Changes
44+
45+
Make your changes to the project. Commits are linted using precommit hooks, meaning that any code that raises linting error cannot be committed. In order to help avoid that, we recommend using an IDE or editor with an eslint plugin in order to streamline the development process. Plugins are available for all the popular editors. For more information see [ESLint Integrations](https://eslint.org/docs/user-guide/integrations)
46+
47+
## Create a Changeset
48+
49+
If you made changes for which you want to trigger a release, you need to create a changeset.
50+
This documents your intent to release, and allows you to specify a message that will be put into the changelog(s) of the package(s).
51+
52+
[More information on changesets](https://github.com/atlassian/changesets)
53+
54+
Run
55+
56+
```sh
57+
yarn changeset
58+
```
59+
60+
And use the menu to select for which packages you need a release, and then select what kind of release. For the release type, we follow [Semantic Versioning](https://semver.org/), so please take a look if you're unfamiliar.
61+
62+
In short:
63+
64+
- A documentation change or similar chore usually does not require a release
65+
- A bugfix requires a patch
66+
- A new feature (feat) requires a minor
67+
- A breaking change requires a major
68+
69+
Exceptions:
70+
71+
- For alpha (<1.0.0), bugfixes and feats are both patches, and breaking changes are allowed as minors.
72+
- For release-candidate and other special cases, other rules may follow.
73+
74+
## Committing Your Changes
75+
76+
Open WC uses [commitlint](https://github.com/marionebl/commitlint) to standardize commit messages in the project. Commit messages must follow the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)
77+
Open WC uses package name as scope. So for example if you fix a _terrible bug_ in the package `@web/test-runner`, the commit message should look like this:
78+
79+
```sh
80+
fix(test-runner): fix terrible bug
81+
```
82+
83+
## Create a Pull Request
84+
85+
Now it's time to push your branch that contains your committed changes to your fork.
86+
87+
```sh
88+
git push -u fork my-awesome-fix
89+
```
90+
91+
After a successful push, if you visit your fork on GitHub, you should see a button that will allow you to create a Pull Request from your forked branch, to our master branch.

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 modern-webdev
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Web
2+
3+
Modern Web, also known as `@web` on npm, is a collection of modern web development tools.
4+
5+
## Packages
6+
7+
-
8+
9+
## Guiding Principles
10+
11+
### Low barrier to entry
12+
13+
We provide tooling that is easy to get into and requires as little prerequisite knowledge as possible. No longer do you need a degree in Webpack to deploy an application.
14+
15+
### Performant
16+
17+
Both from a speed and size perspective, we focus on tooling that helps create performant products and services.
18+
19+
### Close to the platform
20+
21+
Following platform will ensure that your knowledge and skills learnt, remain relevant over time. Frameworks may come and go, but the platform stays.
22+
This means that we value platform solutions over tooling that goes into the opposite direcction.

‎package.json

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"name": "@web/root",
3+
"private": true,
4+
"license": "MIT",
5+
"workspaces": [
6+
"packages/*"
7+
],
8+
"scripts": {
9+
"test": "echo 'no tests in this repo yet'",
10+
"lint:eslint": "eslint --ext .js,.html . --ignore-path .gitignore",
11+
"format:eslint": "eslint --ext .js,.html . --fix --ignore-path .gitignore",
12+
"lint:prettier": "prettier \"**/*.{js,md}\" --check --ignore-path .gitignore",
13+
"format:prettier": "prettier \"**/*.{js,md}\" --write --ignore-path .gitignore",
14+
"lint": "npm run lint:eslint && npm run lint:prettier",
15+
"format": "npm run format:eslint && npm run format:prettier"
16+
},
17+
"devDependencies": {
18+
"@changesets/cli": "^2.8.0",
19+
"@open-wc/eslint-config": "^2.0.0",
20+
"eslint": "^6.1.0",
21+
"eslint-config-prettier": "^6.11.0",
22+
"husky": "^1.0.0",
23+
"lint-staged": "^8.0.0",
24+
"prettier": "^2.0.4"
25+
},
26+
"eslintConfig": {
27+
"extends": [
28+
"@open-wc/eslint-config",
29+
"eslint-config-prettier"
30+
]
31+
},
32+
"prettier": {
33+
"singleQuote": true,
34+
"arrowParens": "avoid",
35+
"printWidth": 100,
36+
"trailingComma": "all"
37+
},
38+
"husky": {
39+
"hooks": {
40+
"pre-commit": "lint-staged"
41+
}
42+
},
43+
"lint-staged": {
44+
"*.js": [
45+
"eslint --fix",
46+
"prettier --write",
47+
"git add"
48+
]
49+
}
50+
}

0 commit comments

Comments
 (0)