From a399529d4b2dc1cbf88f949f5fdc0d3f9101b0b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=82=A8=E3=83=AA=E3=82=B9?= Date: Thu, 16 Apr 2020 20:07:34 +0900 Subject: [PATCH] chore: various cleanup changes (#63) * doc(README.md): update format & added npm install badge * doc(LICENSE): added missing copyright year * doc(NOTICE): added missing file * test(license): added missing licenses and remove ratignore * test(eslint): add missing newline --- .eslintignore | 2 +- .ratignore | 1 - LICENSE | 5 +++-- NOTICE | 5 +++++ README.md | 8 ++++++-- spec/templates/no_content_config.xml | 18 ++++++++++++++++++ spec/templates/withsubdirectory/index.js | 19 +++++++++++++++++++ .../withsubdirectory_package_json/index.js | 19 +++++++++++++++++++ 8 files changed, 71 insertions(+), 6 deletions(-) delete mode 100644 .ratignore create mode 100644 NOTICE diff --git a/.eslintignore b/.eslintignore index 7439d648..38ed2ee9 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1 +1 @@ -spec/templates/ \ No newline at end of file +spec/templates/ diff --git a/.ratignore b/.ratignore deleted file mode 100644 index 79c6997b..00000000 --- a/.ratignore +++ /dev/null @@ -1 +0,0 @@ -spec diff --git a/LICENSE b/LICENSE index 8dada3ed..b7f76dc3 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,4 @@ + Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -178,7 +179,7 @@ APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" + boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a @@ -186,7 +187,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright {yyyy} {name of copyright owner} + Copyright 2020 Apache Cordova Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 00000000..d7aeaa06 --- /dev/null +++ b/NOTICE @@ -0,0 +1,5 @@ +Apache Cordova +Copyright 2020 The Apache Software Foundation + +This product includes software developed at +The Apache Software Foundation (http://www.apache.org/). diff --git a/README.md b/README.md index b6c6a029..2be68356 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,14 @@ # cordova-create +[![NPM](https://nodei.co/npm/cordova-create.png)](https://nodei.co/npm/cordova-create/) + [![Node CI](https://github.com/apache/cordova-create/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/apache/cordova-create/actions?query=branch%3Amaster) [![codecov.io](https://codecov.io/github/apache/cordova-create/coverage.svg?branch=master)](https://codecov.io/github/apache/cordova-create?branch=master) -This module is used for creating cordova style projects. It also incudes support for [cordova templates](http://cordova.apache.org/docs/en/latest/guide/cli/template.html). It can fetch templates from npm and git. +This module is used for creating Cordova style projects. It also incudes support for [Cordova App Templates](http://cordova.apache.org/docs/en/latest/guide/cli/template.html). It can fetch templates from npm and git. -## Usage: +## Usage ```js const create = require('cordova-create'); @@ -36,9 +38,11 @@ await create(dest, opts); ### Parameters #### `dest` + _Required_. Path to the destination where the project will be created. Must be an empty dir if it exists. #### `opts` + _Optional_. Supports following properties. ```js diff --git a/spec/templates/no_content_config.xml b/spec/templates/no_content_config.xml index 2ef7ae42..f9588ed9 100644 --- a/spec/templates/no_content_config.xml +++ b/spec/templates/no_content_config.xml @@ -1,4 +1,22 @@ +