Skip to content

Commit

Permalink
chore: format, lint, & add Apache license
Browse files Browse the repository at this point in the history
  • Loading branch information
erisu committed Nov 5, 2019
1 parent 6972a0c commit e9b497b
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
@@ -1,14 +1,38 @@
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.
#
-->

# @cordova/eslint-config

This repository centralizes the ESLint configuration used for Cordova's development.

## Installation

`eslint-config-cordova` comes with all plugins configs and even `eslint` itself. So all you need to do to get started is:

npm i -D @cordova/eslint-config
`@cordova/eslint-config` comes with all plugins configs and even `eslint` itself. So all you need to do to get started is:

```shell
npm i -D @cordova/eslint-config
```

## Usage

```yml
# In package.json
{
Expand Down Expand Up @@ -39,13 +63,17 @@ extends: '@cordova/eslint-config/browser'
This package exposes the following shareable ESLint configurations:

### `@cordova/eslint-config/node` (or simply `@cordova`)

For linting scripts intended to be run with Node.js.

### `@cordova/eslint-config/node-tests`

For linting Jasmine tests of Cordova's Node.js scripts.

### `@cordova/eslint-config/browser`

For linting cordova-style CommonJS modules intended to be run in the browser (before they are bundled).

### `@cordova/eslint-config/browser-tests`

For linting Jasmine tests of Cordova's browser code.

0 comments on commit e9b497b

Please sign in to comment.