fix(cli): avoid npm gitignore rename on new plugins (#3292)

Co-authored-by: jcesarmobile <jcesarmobile@gmail.com>
ionic-team · Jul 20, 2020 · 2c9b5e1 · 2c9b5e1
1 parent 890f349
commit 2c9b5e1
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/cli/src/common.ts b/cli/src/common.ts
@@ -369,7 +369,10 @@ export function getNpmClient(config: Config, npmClient: string): Promise<string>
 
 export async function copyTemplate(src: string, dst: string) {
   await copyAsync(src, dst);
+  await renameGitignore(dst);
+}
 
+export async function renameGitignore(dst: string) {
   // npm renames .gitignore to something else, so our templates
   // have .gitignore as gitignore, we need to rename it here.
   const gitignorePath = join(dst, 'gitignore');

diff --git a/cli/src/tasks/new-plugin.ts b/cli/src/tasks/new-plugin.ts
@@ -1,5 +1,5 @@
 import { Config } from '../config';
-import { log, logFatal, logInfo, logWarn, runCommand, runTask, writePrettyJSON } from '../common';
+import { log, logFatal, logInfo, logWarn, renameGitignore, runCommand, runTask, writePrettyJSON } from '../common';
 import { OS } from '../definitions';
 import { emoji } from '../util/emoji';
 import { existsAsync, mkdirAsync, readFileAsync, writeFileAsync } from '../util/fs';
@@ -107,6 +107,7 @@ export async function newPlugin(config: Config) {
 
     await runTask('Adding plugin files', async () => {
       await copy(config.plugins.assets.templateDir, pluginPath);
+      await renameGitignore(pluginPath);
       await createTSPlugin(config, pluginPath, domain, className, answers);
       await createIosPlugin(config, pluginPath, domain, className, answers);
       await createAndroidPlugin(config, pluginPath, domain, className);

diff --git a/plugin-template/.gitignore → plugin-template/gitignore b/plugin-template/.gitignore → plugin-template/gitignore
@@ -1,3 +1,7 @@
+# NPM renames .gitignore to .npmignore
+# In order to prevent that, we remove the initial "."
+# And the CLI then renames it
+
 # node files
 dist/
 node_modules/