You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by er...@apache.org on 2019/11/05 09:36:38 UTC
[cordova-eslint] 02/02: chore: format, lint, & add Apache license
This is an automated email from the ASF dual-hosted git repository.
erisu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cordova-eslint.git
commit e9b497b4bd1420f035be93eae53e893adfc5141b
Author: Erisu <el...@gmail.com>
AuthorDate: Wed Oct 23 17:39:23 2019 +0900
chore: format, lint, & add Apache license
---
README.md | 34 +++++++++++++++++++++++++++++++---
1 file changed, 31 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 9af3ae7..f11bd91 100644
--- a/README.md
+++ b/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
{
@@ -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.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org