Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
eslint-config-oceanprotocol
Advanced tools
ESLint configuration for all of Ocean Protocol's JavaScript
💅 🦋 Shareable ESLint config for keeping JavaScript consistent across all of Ocean Protocol's projects, built upon JavaScript Standard Style.
This cat clearly forgot to lint her JavaScript before deployment:
Exhibit A: cat not linting correctly
Don't be like that cat.
Table of Contents
For every project containing JavaScript, ESLint should be set up with this base setup.
npm install --save-dev eslint eslint-config-oceanprotocol
Then, create a new file .eslintrc
in the root of your project and fill with:
{
"extends": "oceanprotocol"
}
When using within a React project use this to get set up:
npm i -D eslint eslint-config-oceanprotocol
And in your .eslintrc
:
{
"extends": ["oceanprotocol", "oceanprotocol/react"]
}
Additionally, you should add Prettier to your project and work with it through ESLint:
npm i -D prettier eslint-config-prettier eslint-plugin-prettier
Then add a .prettierrc
file to the root of your project with this content:
{
"semi": false,
"singleQuote": true,
"trailingComma": "none"
}
Finally, modify your .eslintrc
:
{
"extends": [
"oceanprotocol",
"prettier/standard",
"plugin:prettier/recommended"
],
"plugins": ["prettier"]
}
For maximum fun during coding, install an ESLint plugin in your favorite editor to get suggestions and autofixes as you type.
We keep it simple and follow almost everything defined in the JavaScript Standard Style. Only deviations are:
Again, keeping it simple with 2 files for now:
index.js
: holds all the custom JavaScript linting rulesreact.js
: holds all the custom React linting rulesFor local development, clone this repo and install all dependencies:
git clone git@github.com:oceanprotocol/eslint-config-oceanprotocol.git
cd eslint-config-oceanprotocol/
npm i
Linting is setup against the actual rules within this repo so for testing new rules against every js file in this repo, you can run:
npm test
Releases are managed semi-automatically. They are always manually triggered from a developer's machine with release scripts.
From a clean main
branch you can run the release task bumping the version accordingly based on semantic versioning:
npm run release
The task does the following:
package.json
, package-lock.json
For the GitHub releases steps a GitHub personal access token, exported as GITHUB_TOKEN
is required. Setup
For pre-releases, this is required for the first one like v0.18.0-next.0
:
./node_modules/.bin/release-it major|minor|patch --preRelease=next
Further releases afterwards can be done with npm run release
again and selecting the appropriate next version, in this case v0.18.0-next.1
and so on.
See the CHANGELOG.md file. This file is auto-generated during the above mentioned release process.
See the page titled "Ways to Contribute" in the Ocean Protocol documentation.
Copyright ((C)) 2022 Ocean Protocol Foundation
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.
FAQs
ESLint configuration for all of Ocean Protocol's JavaScript
We found that eslint-config-oceanprotocol demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.