fix: npmignore not needed as we use pkg.files

sanity-io · Nov 3, 2022 · 28a085d · 28a085d
1 parent a0718b5
commit 28a085d
Show file tree

Hide file tree

Showing 10 changed files with 1 addition and 69 deletions.
diff --git a/.npmignore b/.npmignore
diff --git a/README.md b/README.md
@@ -239,7 +239,7 @@ If the plugin is shared across multiple "private" studios: register an organizat
 Also; you cannot easily remove modules/versions from npm once published. 
 Take a good look at your `package.json` to see that the fields in there makes sense to you,
 and make sure there are no "secrets" (authorization tokens, API keys or similar) in the plugin directory - 
-anything not listed in `.npmignore` will be part of the published module.
+any files within folders defined in the `files` field inside `package.json` will be included with your module.
 
 When you're ready to publish, run `npm publish` (or `yarn publish` if you prefer). 
 The `prepublishOnly` task should kick in and compile the source files, then verify the built output to ensure it looks good.

diff --git a/assets/inject/npmignore b/assets/inject/npmignore
diff --git a/src/actions/inject.ts b/src/actions/inject.ts
@@ -346,7 +346,6 @@ async function writeStaticAssets(options: InjectOptions) {
 
   const files: FromTo[] = [
     {from: 'editorconfig', to: '.editorconfig'},
-    {from: 'npmignore', to: '.npmignore'},
     {from: 'sanity.json', to: 'sanity.json'},
     {from: 'v2-incompatible.js.template', to: 'v2-incompatible.js'},
     {

diff --git a/test/fixtures/inject/valid/.npmignore b/test/fixtures/inject/valid/.npmignore
diff --git a/test/fixtures/verify-package/every-failure-possible/.npmignore b/test/fixtures/verify-package/every-failure-possible/.npmignore
diff --git a/test/fixtures/verify-package/fresh-v2-movie-studio/.npmignore b/test/fixtures/verify-package/fresh-v2-movie-studio/.npmignore
diff --git a/test/fixtures/verify-package/invalid-eslint/.npmignore b/test/fixtures/verify-package/invalid-eslint/.npmignore
diff --git a/test/fixtures/verify-package/valid/.npmignore b/test/fixtures/verify-package/valid/.npmignore
diff --git a/test/init.test.ts b/test/init.test.ts
@@ -61,7 +61,6 @@ tap.test('plugin-kit init --force in empty directory', async (t) => {
         'lint-staged.config.js',
         '*.js'
       )
-      await fileContains('.npmignore', '/test')
       await fileContains('.prettierrc.js', 'semi: false')
       await fileContains('sanity.json', '"path": "./v2-incompatible.js"')
       await fileContains('v2-incompatible.js', 'showIncompatiblePluginDialog')