Skip to content

Commit

Permalink
Merge pull request #9 from smithki/development
Browse files Browse the repository at this point in the history 
v0.5.2
  • Loading branch information
@smithki
smithki authored Feb 10, 2020
2 parents 6e14e1c + e1e7551 commit 236c5a4
Show file tree
Hide file tree
Showing 90 changed files with 1,120 additions and 149 deletions.
127 changes: 90 additions & 37 deletions .circleci/config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,61 @@
# CI INSTRUCTIONS #
# ~~~~~~~~~~~~~~~ #
# This configuration is optimized for continuous delivery of NPM packages #
# using Yarn. #
# using Lerna (fixed version) + Yarn. #
# ---------------------------------------------------------------------------- #
# #
# 1) Publish the initial version of your NPM package manually, ensuring the #
# correct org scope and settings. #
# 1) Install & initialize Lerna: `yarn add -D lerna && lerna init` #
# #
# #
# 2) Environment variables required in CircleCI: #
# 2) Publish the initial version of your NPM packages manually, ensuring the #
# correct org scope and settings: `lerna publish` #
# #
# #
# 3) Environment variables required in CircleCI: #
# #
# $NPM_TOKEN -- NPM publishing auth token. #
# $GITHUB_REPO_TOKEN -- GitHub repo-scoped auth token (for use with GREN). #
# #
# #
# 3) The following branches should be created & protected on GitHub: #
# 4) The following configuration should be added in your root `package.json`: #
# #
# { #
# "workspaces": [ #
# "packages/*" #
# ] #
# } #
# #
# #
# 5) The following configuration should be added to your `lerna.json`: #
# #
# { #
# "npmClient": "yarn", #
# "useWorkspaces": true #
# } #
# #
# #
# 6) The following branches should be created & protected on GitHub: #
# ^^^^^^^^^ #
# master -- Production code (currently published NPM version). #
# next -- Pre-release code (published under the `next` tag on NPM). #
# development -- Work-in-progress code (not published). This should be set #
# as the default branch! #
# #
# #
# 4) The following scripts should be created in `package.json`: #
# 7) The following scripts should be created in each lerna package's own #
# `package.json`: #
# #
# lint -- Run a linter against source files. #
# build -- Build output required for publishing to NPM. #
# test -- Run unit/integration/e2e tests. #
# lint -- Run a linter against source files. #
# build -- Build output required for publishing to NPM. #
# test -- Run unit/integration/e2e tests. #
# #
# #
# 5) Ensure the aliases for `&dependency-paths` and `&build-output-paths` #
# 8) Ensure the aliases for `&dependency-paths` and `&build-output-paths` #
# below properly reflect the dependency and output directories of your #
# app or module. #
# #
# #
# 6) [OPTIONAL] Configure GREN to your liking using `.grenrc`. #
# 9) [OPTIONAL] Configure GREN to your liking using `.grenrc`. #
# #
# See: https://github.com/github-tools/github-release-notes #
# #
Expand All @@ -49,17 +70,46 @@ aliases: [
# List of dependency paths that should be persisted to the
# CircleCI workspace.
&dependency-paths [
"node_modules"
"node_modules",
"packages/usable-react/node_modules",
"packages/use-compare/node_modules",
"packages/use-debounced/node_modules",
"packages/use-deferred-children/node_modules",
"packages/use-dom-event/node_modules",
"packages/use-effect-after-mount/node_modules",
"packages/use-effect-trigger/node_modules",
"packages/use-filter/node_modules",
"packages/use-force-update/node_modules",
"packages/use-hash/node_modules",
"packages/use-hash-compare/node_modules",
"packages/use-initial-render/node_modules",
"packages/use-interval/node_modules",
"packages/use-previous/node_modules",
"packages/use-timer/node_modules",
],

# List of build output paths that should be persisted to the
# CircleCI workspace.
&build-output-paths [
"dist"
"packages/usable-react/dist",
"packages/use-compare/dist",
"packages/use-debounced/dist",
"packages/use-deferred-children/dist",
"packages/use-dom-event/dist",
"packages/use-effect-after-mount/dist",
"packages/use-effect-trigger/dist",
"packages/use-filter/dist",
"packages/use-force-update/dist",
"packages/use-hash/dist",
"packages/use-hash-compare/dist",
"packages/use-initial-render/dist",
"packages/use-interval/dist",
"packages/use-previous/dist",
"packages/use-timer/dist",
],

# Yarn lockfile cache key (update "vN" => "vN+1" to cache-bust).
&dependency-cache-key "v1-dependency-cache-{{ checksum \"yarn.lock\" }}",
&dependency-cache-key "v2-dependency-cache-{{ checksum \"yarn.lock\" }}",

&workspace-root "/home/circleci/project",

Expand Down Expand Up @@ -118,7 +168,10 @@ jobs:
key: *dependency-cache-key
- run:
name: Install Module Dependencies
command: yarn install
command: yarn install --frozen-lockfile
- run:
name: Lerna Bootstrap
command: npx lerna bootstrap
- save_cache:
paths: *dependency-paths
key: *dependency-cache-key
Expand All @@ -134,7 +187,7 @@ jobs:
- *attach-workspace
- run:
name: Lint source files
command: yarn lint
command: npx lerna run lint

# Builds modules and persists the build output to the workspace.
build:
Expand All @@ -144,7 +197,7 @@ jobs:
- *attach-workspace
- run:
name: Build modules
command: yarn build
command: npx lerna run build
- persist_to_workspace:
paths: *build-output-paths
root: *workspace-root
Expand All @@ -157,7 +210,7 @@ jobs:
- *attach-workspace
- run:
name: Run tests
command: yarn test
command: npx lerna run test

# Publish the package to NPM. This should depend on the `build` job.
create-release:
Expand All @@ -170,7 +223,7 @@ jobs:
command: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
- run:
name: Publish package to NPM
command: npm publish
command: npx lerna publish from-package --yes

# Publish the package as a pre-release version to NPM. This should depend on
# the `build` job.
Expand All @@ -184,7 +237,7 @@ jobs:
command: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
- run:
name: Publish pre-release package to NPM
command: npm publish --tag next
command: npx lerna publish from-package --canary --yes

# Create a git tag for this release and push to the remote repository.
tag-release:
Expand All @@ -195,12 +248,12 @@ jobs:
- run:
name: Git tag the release with the `package.json` version number
command: |
PACKAGE_VERSION=$(node -pe "require('./package.json')['version']")
PACKAGE_VERSION=$(node -pe "require('./lerna.json')['version']")
git tag v$PACKAGE_VERSION
- run:
name: Push git tag to the remote repository
command: |
PACKAGE_VERSION=$(node -pe "require('./package.json')['version']")
PACKAGE_VERSION=$(node -pe "require('./lerna.json')['version']")
git push -q https://[email protected]/$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME.git v$PACKAGE_VERSION
# Create release notes on GitHub using the `github-release-notes` package.
Expand Down Expand Up @@ -239,35 +292,35 @@ workflows:
jobs:
- install-dependencies: *filter-default-branches

- lint:
- build:
requires:
- install-dependencies

- build:
- test:
requires:
- lint
- install-dependencies

- test:
- lint:
requires:
- lint
- build

# Builds modules, verifies code with the linter, runs unit tests, and
# publishes the built package to NPM.
publish-to-npm:
jobs:
- install-dependencies: *filter-release-branches-only

- lint:
- build:
requires:
- install-dependencies

- build:
- test:
requires:
- lint
- install-dependencies

- test:
- lint:
requires:
- lint
- build

# Manual approval step as a final gatekeeper to prevent
# possible mistakes!
Expand Down Expand Up @@ -297,17 +350,17 @@ workflows:
jobs:
- install-dependencies: *filter-prerelease-branches-only

- lint:
- build:
requires:
- install-dependencies

- build:
- test:
requires:
- lint
- install-dependencies

- test:
- lint:
requires:
- lint
- build

- create-prerelease:
requires:
Expand Down
8 changes: 6 additions & 2 deletions .eslintrc
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"extends": ["@ikscodes/eslint-config"],
"parserOptions": {
"project": "./tsconfig.json"
"project": [
"./tsconfig.json"
]
},
"rules": {
"import/extensions": 0,
Expand All @@ -10,7 +12,9 @@
"settings": {
"import/resolver": {
"typescript": {
"directory": ["tsconfig.json"]
"directory": [
"tsconfig.json"
]
}
}
}
Expand Down
10 changes: 5 additions & 5 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
node_modules/**/*
/**/node_modules/**/*
npm-debug.log
src/**/*.js
src/**/*.js.map
dist/**
test-dist/**
yarn-error.log
lerna-debug.log
/**/dist/**/*
.vscode/**/*
.rts2_cache_*
/**/.rts2_cache_*
11 changes: 11 additions & 0 deletions lerna.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"packages": [
"packages/*"
],
"workspaces": [
"packages/*"
],
"version": "0.5.2",
"npmClient": "yarn",
"useWorkspaces": true
}
49 changes: 16 additions & 33 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,18 @@
{
"name": "usable-react",
"version": "0.5.0",
"description": "Basic React hooks to get any project off the ground.",
"author": "Ian K Smith <[email protected]>",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/smithki/usable-react"
},
"files": [
"dist/**/*"
],
"main": "dist/index.js",
"umd:main": "dist/index.umd.js",
"module": "dist/index.m.js",
"types": "dist/index.d.ts",
"unpkg": "dist/index.umd.js",
"private": true,
"scripts": {
"dev": "npm-run-all -s clean:dist -p compile_watch",
"build": "npm-run-all -s clean:dist -p compile",
"lint": "eslint --fix src/**/*.{ts,tsx}",
"compile": "microbundle build src/index.ts --name UsableReact --target web --external react",
"compile_watch": "microbundle watch src/index.ts --name UsableReact --target web --external react",
"clean": "npm-run-all -s clean:*",
"clean:dist": "rimraf dist",
"clean:cache": "rimraf .rts2_cache_*",
"test": "echo \"No tests to run!\""
"bootstrap": "lerna bootstrap",
"exec": "lerna exec --scope $PKG -- $@",
"dev": "./scripts/clean.sh && ./scripts/dev.sh",
"build": "./scripts/clean.sh && ./scripts/build.sh",
"clean": "./scripts/clean.sh",
"lint": "./scripts/lint.sh",
"test": "echo \"No tests to run!\"",
"patch": "lerna version patch --no-git-tag-version",
"minor": "lerna version minor --no-git-tag-version",
"major": "lerna version major--no-git-tag-version",
"release": "lerna publish from-package --yes",
"release_canary": "lerna publish from-package --canary --yes"
},
"devDependencies": {
"@ikscodes/eslint-config": "^6.2.0",
Expand All @@ -52,11 +39,7 @@
"rimraf": "^2.6.1",
"typescript": "^3.0.3"
},
"peerDependencies": {
"react": "^16.11.0"
},
"dependencies": {
"fuse.js": "^3.4.6",
"object-hash": "^2.0.1"
}
"workspaces": [
"packages/*"
]
}
3 changes: 3 additions & 0 deletions packages/usable-react/.eslintrc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "../../.eslintrc"
}
21 changes: 21 additions & 0 deletions packages/usable-react/LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018-present

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.
Loading

0 comments on commit 236c5a4

Please sign in to comment.