-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 3c2b82a
Showing
66 changed files
with
20,925 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[*] | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.js] | ||
tab_width = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node | ||
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions | ||
|
||
# To get proper caching for monorepos we use actions/cache@eb78578266b7cec649ab65b6f1534bd6040c838b (from master branch) | ||
# instead of actions/cache@1. Support for monorepos will be available in actions/cache@2. | ||
|
||
name: Node.js CI | ||
|
||
on: | ||
push: | ||
branches: [ master ] | ||
pull_request: | ||
branches: [ master ] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
strategy: | ||
matrix: | ||
node-version: [12.x] | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Use Node.js ${{ matrix.node-version }} | ||
uses: actions/setup-node@v1 | ||
with: | ||
node-version: ${{ matrix.node-version }} | ||
- name: restore lerna | ||
id: cache | ||
uses: actions/cache@eb78578266b7cec649ab65b6f1534bd6040c838b | ||
with: | ||
path: | | ||
node_modules | ||
*/*/node_modules | ||
key: n-${{ runner.os }}-${{ hashFiles('yarn.lock') }} | ||
- name: Install Dependencies | ||
if: steps.cache.outputs.cache-hit != 'true' | ||
run: yarn | ||
# - name: Build local packages | ||
# run: yarn build | ||
- run: yarn test | ||
env: | ||
CI: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
node_modules | ||
coverage/ | ||
.fixtures | ||
.DS_Store | ||
yarn-error.log |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
v12.14.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
{ | ||
"version": "0.2.0", | ||
"configurations": [ | ||
{ | ||
"name": "Chrome", | ||
"type": "chrome", | ||
"request": "launch", | ||
"url": "http://localhost:3000", | ||
"webRoot": "${workspaceRoot}/workspaces/web-app/src", | ||
"sourceMapPathOverrides": { | ||
"webpack:///web-app/src/*": "${webRoot}/*" | ||
} | ||
}, | ||
{ | ||
"type": "node", | ||
"request": "launch", | ||
"name": "Jest All", | ||
"program": "${workspaceRoot}/node_modules/jest/bin/jest", | ||
"args": ["--runInBand"], | ||
"console": "integratedTerminal", | ||
"internalConsoleOptions": "neverOpen" | ||
}, | ||
{ | ||
"type": "node", | ||
"request": "launch", | ||
"name": "Jest Current File", | ||
"program": "${workspaceRoot}/node_modules/jest/bin/jest", | ||
"args": ["${file}"], | ||
"console": "integratedTerminal", | ||
"internalConsoleOptions": "neverOpen" | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"jest.pathToJest": "npm test --", | ||
"jest.restartJestOnSnapshotUpdate": true, | ||
"spellright.language": [ | ||
"en", | ||
"pl" | ||
], | ||
"spellright.documentTypes": [ | ||
"markdown", | ||
"latex", | ||
"plaintext" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,203 @@ | ||
# Contributing | ||
|
||
> Working on your first Pull Request? You can learn how from this *free* series | ||
> [How to Contribute to an Open Source Project on | ||
> GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) | ||
## Quick start | ||
|
||
After you clone your forked repo, follow the following steps to bootstrap your | ||
local environment: | ||
|
||
```bash | ||
» yarn install | ||
» yarn setup:dev | ||
» yarn test | ||
» (cd workspaces/homepage && yarn develop) | ||
# or to get everything like in production | ||
» now dev | ||
``` | ||
|
||
## Code organization | ||
|
||
Crypton is a monorepo. It consists of a number of packages that all live under the `workspaces` folder. We use a combination of [lerna](https://lernajs.io) and [yarn | ||
workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) to manage them. | ||
|
||
### yarn install | ||
|
||
We install all mono-repo dependencies with single top-level `yarn install` or just `yarn`. | ||
|
||
## Building packages | ||
|
||
Because our monorepo contains a number of *packages* under the `workspaces` directory, some of them may need to be build before they can be published. | ||
The build command uses `lerna` in order to trigger the build script | ||
for every single workspace. Please use a convenience script `build` defined in the root `package.json`. | ||
|
||
### Run tests | ||
|
||
We run all the tests from the top level - this is far more efficient | ||
especially if the number of workspaces in the monorepo increases: | ||
|
||
```bash | ||
» yarn test | ||
» yarn test --no-cache // good to know this | ||
» yarn jest --clearCache // a nice one | ||
``` | ||
|
||
### Confluenza-based homepage | ||
|
||
This is our landing page. It uses [Confluenza](https://confluenza.online), which is based on [Gatsby](https://www.gatsbyjs.org/). | ||
|
||
To start development server or to build version that is ready for distribution you can run: | ||
|
||
```bash | ||
» cd workspaces/homepage | ||
» yarn develop | ||
» yarn build | ||
``` | ||
|
||
## Using now dev | ||
|
||
Take advantage of `now dev` to run a development server and have a mirror of your production hot-reloading. Read more at [Introducing `now dev` – Serverless, on localhost](https://zeit.co/blog/now-dev). | ||
|
||
## Babel 7 | ||
|
||
We use Babel 7. | ||
|
||
Babel 7 has changed in how babel configuration is discovered. | ||
|
||
It allows three different configuration files: `babel.config.js`, | ||
`.babelrc.js`, and the familiar `.babelrc`. The semantics of file | ||
discovery have changed. If `babel.config.js` is present at your | ||
current working directory, only this file will be used and `.babelrc` | ||
and `.babelrc.js` will be ignored (and it does not matter if they are | ||
in your `cwd` or in one of the subfolders). | ||
|
||
If `babel.config.js` is not present, you can decide to either use | ||
`.babelrc` for static configuration or `.babelrc.js` if you prefer to | ||
programmatically create your configuration. If you use the `.babelrc` variant, please notice that Babel 7 will look for a `.babelrc` in the current directory. If Babel finds | ||
other `.babelrc` files while transpiling files in a subfolder, it will merge the configurations together. | ||
|
||
Because our packages share the same Babel configuration, we chose | ||
to create a single top-level `babel.config.js` where we can | ||
programmatically create the configuration based on the `BABEL_ENV` and | ||
`NODE_ENV` environment variables. The same configuration file is used | ||
to run jest tests. | ||
|
||
We could not avoid having babel configurations in subfolders because | ||
the babel 7 does not continue searching above the first `package.json` that it finds, and we run the `yarn build` command for the packages via top-level `yarn lerna run build`, which means it will be executed from the package folder. | ||
|
||
Fortunately, we are able to reuse the top-level | ||
`babel.config.js` by having the package-specific `babel.config.js` | ||
with just the following content: | ||
|
||
```javascript | ||
module.exports = { | ||
extends: '../../babel.config.js' | ||
} | ||
``` | ||
|
||
Alternatively, you can also use `.babelrc.js` with the following content: | ||
|
||
```javascript | ||
const babelConfig = require('../../babel.config') | ||
|
||
module.exports = babelConfig | ||
``` | ||
|
||
> In this case, make sure that you do not use the `--no-babelrc` | ||
option in any of the babel commands in the `tools/build.js` top-level | ||
script. | ||
|
||
|
||
So to summarize, we have a top-level `babel.config.js` and then for each package that we intend to publish to npm registry or which needs a custom babel configuration we have a `babel.config.js` file in the corresponding workspace directory. | ||
|
||
> Please notice that we run tests from the top-running of the tests is nicely handled by the top-level `babel.config.js`. | ||
### Read more about babel | ||
|
||
In order to get a better grip on Babel 7 and how does it handle configuration files in version 7, | ||
please refer to the following documents: | ||
|
||
1. [Configure Babel](https://babeljs.io/docs/en/configuration) | ||
2. [Config Files](https://babeljs.io/docs/en/config-files) | ||
|
||
|
||
## Staying in sync with upstream | ||
|
||
You can follow the steps described in [Syncing a | ||
fork](https://help.github.com/articles/syncing-a-fork/). We recommend that you | ||
keep your local master branch pointing to the upstream master branch. Remaining | ||
in sync then becomes really easy: | ||
|
||
```bash | ||
git remote add upstream https://github.com/identity-box/crypton.git | ||
git fetch upstream | ||
git branch --set-upstream-to=upstream/master master | ||
``` | ||
|
||
Now, when you do `git pull` from your local `master` branch git will | ||
fetch changes from the `upstream` remote. Then you can make all of | ||
your pull request branches based on this `master` branch. | ||
|
||
## Submitting a Pull Request | ||
|
||
Please go through existing issues and pull requests to check if | ||
somebody else is already working on it, we use `someone working on it` | ||
label to mark such issues. | ||
|
||
## Creating releases | ||
|
||
We define a release as a sequence of Pull Requests. When creating a pull request that | ||
should be part of a next release, we add one of the following labels to it: | ||
|
||
- PR: Breaking Change :bomb:, | ||
- PR: New Feature :rocket:, | ||
- PR: Enhancement :heart_eyes_cat:, | ||
- PR: Bug Fix :bug:, | ||
- PR: Documentation :book:, | ||
- PR: Refactoring :hammer: | ||
|
||
Some discipline is required to make sure that a pull request is focused on one of the above | ||
mentioned categories. One can say that our releases are pull-request-oriented rather than commit oriented. | ||
This allows us to have enough information and structure while leaving a level of freedom. This is in contrast to so-called _conventional commits_, where each commit must adhere to a set of predefined formatting rules. We find this restriction an inconvenience. | ||
|
||
We use [lerna-changelog](https://www.npmjs.com/package/lerna-changelog) to have some level of automation, so that not everything needs to be done by hand. We describe the process of creating a release below. | ||
|
||
### Publishing packages | ||
|
||
Because we have consciously chosen to have one version for all our packages, it is important to run `lerna publish` with `--force-publish` option: | ||
|
||
```bash | ||
$ yarn lerna publish --force-publish | ||
``` | ||
|
||
This will not only remove confusion among our users, but will also make releases easier to follow. | ||
|
||
### Updating CHANGELOG.md | ||
|
||
After packages are published and all relevant Pull Requests are merged to the master branch, we run: | ||
|
||
```bash | ||
$ yarn lerna-changelog --from=vx.y.z --to=vX.Y.Z | ||
``` | ||
|
||
where `vx.y.z` refers to the release tag preceding the most recent tag `vX.Y.Z`. Foe example, if last release was tagged `v1.0.18` and the tag for the candidate release already merged and pushed to master is `v1.0.19`, then the command would be: | ||
|
||
```bash | ||
$ yarn lerna-changelog --from=v1.0.18 --to=v1.0.19 | ||
``` | ||
|
||
The output of this command should be then manually prepended to `CHANGELOG.md` and pushed to the master branch. | ||
|
||
### Draft a new release | ||
|
||
On github, use _Draft a new release_ using the output of the `lerna-changelog` command as the input. | ||
Adjust the fields so that the new release follows the structure of previous releases (unless a new formatting is desired). | ||
|
||
### Read more about releasing code | ||
|
||
- [lerna-changelog](https://github.com/lerna/lerna-changelog) | ||
- [using conventional commits with lerna](https://medium.com/angular-in-depth/release-management-in-angular-with-lerna-21b4ab417c59) | ||
- [semantic-release](https://semantic-release.gitbook.io/semantic-release/) | ||
- [semantic-release and monorepos discussion](https://github.com/semantic-release/semantic-release/issues/193) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 Crypton | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Crypton | ||
|
||
Private, end-to-end encrypted markdown pad for Identity Box. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
module.exports = function (api) { | ||
const babelEnv = api.env() | ||
api.cache(true) | ||
|
||
const presets = setupPresets(babelEnv) | ||
const plugins = setupPlugins(babelEnv) | ||
const ignore = setupIgnoredFiles(babelEnv) | ||
|
||
return { | ||
presets, | ||
plugins, | ||
ignore | ||
} | ||
} | ||
|
||
function setupPresets (babelEnv) { | ||
let presetEnv = [ | ||
'@babel/preset-env', | ||
{ | ||
exclude: ['transform-regenerator'] | ||
} | ||
] | ||
|
||
if (babelEnv === 'es') { | ||
presetEnv = [ | ||
'@babel/preset-env', | ||
{ | ||
modules: false, | ||
exclude: ['transform-regenerator'] | ||
} | ||
] | ||
} | ||
|
||
return [ | ||
presetEnv, | ||
'@babel/preset-react' | ||
] | ||
} | ||
|
||
function setupPlugins (babelEnv) { | ||
if (babelEnv === 'test') { | ||
return [ | ||
[ | ||
'emotion', | ||
{ sourceMap: true, autoLabel: true } | ||
], | ||
'@babel/plugin-proposal-object-rest-spread', | ||
'@babel/plugin-proposal-class-properties' | ||
] | ||
} else { | ||
return [ | ||
'@babel/plugin-proposal-object-rest-spread', | ||
'@babel/plugin-proposal-class-properties' | ||
] | ||
} | ||
} | ||
|
||
function setupIgnoredFiles (babelEnv) { | ||
let ignore | ||
|
||
if (babelEnv !== 'test') { | ||
ignore = [ | ||
'**/*.test.js', | ||
'**/__mocks__/**' | ||
] | ||
} | ||
|
||
return ignore | ||
} |
Oops, something went wrong.