@square/web-sdk
v2.0.1
Published
Square Web SDK
Downloads
46,726
Readme
web-sdk
Development
Getting Started
This project uses Node v16 as defined by .nvmrc
to take advantage of npm@7. You can use nvm to install the correct version:
nvm install $(cat .nvmrc)
Install dependencies with npm which should also install git hooks with husky.
npm install
You can verify husky installed correctly by verifying the output of git config core.hooksPath
is .husky
. If this didn't work for some reason, you can run npx husky install
.
Testing
You can run all linters, tests, and builds like CI with npm test
.
Unit
Jest is used as the testing framework providing the runner, structure, assertions, mocks, and coverage among other features.
npm run test:unit
Linting
You can run all linters with npm run lint
.
ESLint
ESLint analyzes the code to find and fix problems. We use eslint-plugin-square for out-of-the-box configuration.
npm run lint:eslint
Fixing warnings and errors automatically
ESLint can sometimes fix warnings and errors automatically for you with its --fix option.
npm run lint:eslint --fix
Prettier
Prettier is an opinionated code formatter. We use @square/prettier-config for those opinions.
npm run lint:prettier
Fixing code style issues
If after running npm run lint:prettier
you get a warning like, "Code style issues found in the above file(s). Forgot to run Prettier?", you can have Prettier fix them.
npm run lint:prettier:fix
Building
TypeScript is used to build the module that is published to npm.
npm run build
Conventional Commits
Conventional Commits are used for commit messages which allows us to automate changelogs and releases that dovetail with SemVer.
Continuous Integration
GitHub Actions is used for our CI/CD workflows. See .github/workflows
for details.
License
Copyright 2021 Square Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.