├── .editorconfig ├── .gitattributes ├── .github ├── security.md └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── 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/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 | - 20 14 | - 18 15 | steps: 16 | - uses: actions/checkout@v4 17 | - uses: actions/setup-node@v4 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | Check if a file path is a text file. 3 | 4 | @example 5 | ``` 6 | import isTextPath from 'is-text-path'; 7 | 8 | isTextPath('source/unicorn.txt'); 9 | //=> true 10 | 11 | isTextPath('source/unicorn.png'); 12 | //=> false 13 | ``` 14 | */ 15 | export default function isTextPath(filepath: string): boolean; 16 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import path from 'node:path'; 2 | import textExtensions from 'text-extensions'; 3 | 4 | const extensions = new Set(textExtensions); 5 | 6 | export default function isTextPath(filePath) { 7 | return extensions.has(path.extname(filePath).slice(1).toLowerCase()); 8 | } 9 | -------------------------------------------------------------------------------- /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-text-path", 3 | "version": "3.0.0", 4 | "description": "Check if a file path is a text file", 5 | "license": "MIT", 6 | "repository": "sindresorhus/is-text-path", 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": { 15 | "types": "./index.d.ts", 16 | "default": "./index.js" 17 | }, 18 | "sideEffects": false, 19 | "engines": { 20 | "node": ">=18.20" 21 | }, 22 | "scripts": { 23 | "test": "xo && ava" 24 | }, 25 | "files": [ 26 | "index.js", 27 | "index.d.ts" 28 | ], 29 | "keywords": [ 30 | "text", 31 | "extensions", 32 | "extension", 33 | "file", 34 | "path", 35 | "check", 36 | "detect", 37 | "is" 38 | ], 39 | "dependencies": { 40 | "text-extensions": "^3.0.0" 41 | }, 42 | "devDependencies": { 43 | "ava": "^6.1.2", 44 | "xo": "^0.58.0" 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # is-text-path 2 | 3 | > Check if a file path is a text file 4 | 5 | ## Install 6 | 7 | ```sh 8 | npm install is-text-path 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import isTextPath from 'is-text-path'; 15 | 16 | isTextPath('source/unicorn.txt'); 17 | //=> true 18 | 19 | isTextPath('source/unicorn.png'); 20 | //=> false 21 | ``` 22 | 23 | ## Related 24 | 25 | - [`text-extensions`](https://github.com/sindresorhus/text-extensions) - List of text file extensions 26 | - [`is-binary-path`](https://github.com/sindresorhus/is-binary-path) - Check if a file path is a binary file 27 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import isTextPath from './index.js'; 3 | 4 | test('main', t => { 5 | t.true(isTextPath('unicorn.txt')); 6 | t.true(isTextPath('unicorn.md')); 7 | t.true(isTextPath('unicorn.MD')); 8 | t.false(isTextPath('unicorn.png')); 9 | t.false(isTextPath('unicorn.zip')); 10 | t.false(isTextPath('unicornzip')); 11 | }); 12 | --------------------------------------------------------------------------------