├── .editorconfig ├── .gitattributes ├── .github ├── funding.yml ├── security.md └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── index.test-d.ts ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/funding.yml: -------------------------------------------------------------------------------- 1 | github: sindresorhus 2 | tidelift: npm/is-npm 3 | -------------------------------------------------------------------------------- /.github/security.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. 4 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 16 14 | steps: 15 | - uses: actions/checkout@v2 16 | - uses: actions/setup-node@v2 17 | with: 18 | node-version: ${{ matrix.node-version }} 19 | - run: npm install 20 | - run: npm test 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | Check if your code is running as an [npm](https://docs.npmjs.com/misc/scripts) or [yarn](https://yarnpkg.com/cli/run) script. 3 | 4 | @example 5 | ``` 6 | import {isNpmOrYarn} from 'is-npm'; 7 | 8 | if (isNpmOrYarn) { 9 | console.log('Running as an npm or yarn script!'); 10 | } 11 | ``` 12 | */ 13 | export const isNpmOrYarn: boolean; 14 | 15 | /** 16 | Check if your code is running as an [npm](https://docs.npmjs.com/misc/scripts) script. 17 | 18 | @example 19 | ``` 20 | import {isNpm} from 'is-npm'; 21 | 22 | if (isNpm) { 23 | console.log('Running as an npm script!'); 24 | } 25 | ``` 26 | */ 27 | export const isNpm: boolean; 28 | 29 | /** 30 | Check if your code is running as a [yarn](https://yarnpkg.com/cli/run) script. 31 | 32 | @example 33 | ``` 34 | import {isYarn} from 'is-npm'; 35 | 36 | if (isYarn) { 37 | console.log('Running as a yarn script!'); 38 | } 39 | ``` 40 | */ 41 | export const isYarn: boolean; 42 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import process from 'node:process'; 2 | 3 | const packageJson = process.env.npm_package_json; 4 | const userAgent = process.env.npm_config_user_agent; 5 | const isNpm6 = Boolean(userAgent && userAgent.startsWith('npm')); 6 | const isNpm7 = Boolean(packageJson && packageJson.endsWith('package.json')); 7 | 8 | export const isNpm = isNpm6 || isNpm7; 9 | export const isYarn = Boolean(userAgent && userAgent.startsWith('yarn')); 10 | export const isNpmOrYarn = isNpm || isYarn; 11 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import {isNpmOrYarn, isYarn, isNpm} from './index.js'; 3 | 4 | expectType(isNpmOrYarn); 5 | expectType(isNpm); 6 | expectType(isYarn); 7 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "is-npm", 3 | "version": "6.0.0", 4 | "description": "Check if your code is running as an npm script", 5 | "license": "MIT", 6 | "repository": "sindresorhus/is-npm", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": "^12.20.0 || ^14.13.1 || >=16.0.0" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava && tsd" 20 | }, 21 | "files": [ 22 | "index.js", 23 | "index.d.ts" 24 | ], 25 | "keywords": [ 26 | "npm", 27 | "yarn", 28 | "is", 29 | "check", 30 | "detect", 31 | "env", 32 | "environment", 33 | "run", 34 | "script" 35 | ], 36 | "devDependencies": { 37 | "ava": "^3.15.0", 38 | "tsd": "^0.17.0", 39 | "xo": "^0.44.0" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # is-npm 2 | 3 | > Check if your code is running as an [npm](https://docs.npmjs.com/misc/scripts) or [yarn](https://yarnpkg.com/cli/run) script 4 | 5 | ## Install 6 | 7 | ```sh 8 | npm install is-npm 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import {isNpmOrYarn, isNpm, isYarn} from 'is-npm'; 15 | 16 | console.table({isNpmOrYarn, isNpm, isYarn}); 17 | ``` 18 | 19 | ```sh 20 | $ node foo.js 21 | # ┌─────────────┬────────┐ 22 | # │ (index) │ Values │ 23 | # ├─────────────┼────────┤ 24 | # │ isNpmOrYarn │ false │ 25 | # │ isNpm │ false │ 26 | # │ isYarn │ false │ 27 | # └─────────────┴────────┘ 28 | $ npm run foo 29 | # ┌─────────────┬────────┐ 30 | # │ (index) │ Values │ 31 | # ├─────────────┼────────┤ 32 | # │ isNpmOrYarn │ true │ 33 | # │ isNpm │ true │ 34 | # │ isYarn │ false │ 35 | # └─────────────┴────────┘ 36 | $ yarn run foo 37 | # ┌─────────────┬────────┐ 38 | # │ (index) │ Values │ 39 | # ├─────────────┼────────┤ 40 | # │ isNpmOrYarn │ true │ 41 | # │ isNpm │ false │ 42 | # │ isYarn │ true │ 43 | # └─────────────┴────────┘ 44 | ``` 45 | 46 | ## Related 47 | 48 | - [is-npm-cli](https://github.com/sindresorhus/is-npm-cli) - CLI for this module 49 | 50 | --- 51 | 52 |
53 | 54 | Get professional support for this package with a Tidelift subscription 55 | 56 |
57 | 58 | Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies. 59 | 60 |
61 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import {isNpm} from './index.js'; 3 | 4 | test('main', t => { 5 | t.true(isNpm); 6 | }); 7 | --------------------------------------------------------------------------------