Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/denniscual/find-text
Fast, minimal, and easy to use tool for finding text across multiple files
https://github.com/denniscual/find-text
Last synced: 5 days ago
JSON representation
Fast, minimal, and easy to use tool for finding text across multiple files
- Host: GitHub
- URL: https://github.com/denniscual/find-text
- Owner: denniscual
- Created: 2018-05-30T02:36:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-05-31T16:59:05.000Z (over 6 years ago)
- Last Synced: 2024-12-07T20:55:59.167Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 93.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## find-text
Fast, minimal, and easy to use tool for finding text across multiple files. It is tiny (3.78kb bundle size, including dependecies) file.
[](https://www.npmjs.com/package/find-text) [](https://travis-ci.org/denniscual/find-text) [](https://standardjs.com)
## Install
```bash
npm install find-text
```
## Usage
The module exposes two API's `findText` and `findTextInFiles`.
### findText
```js
import { findText } from 'find-text'
/**
* findText :: (String, String) => Promise
*
* Find the text on the given file.
*/
findText('TODO', '/Users/user/Desktop/sample/src/users.js')
.then((results) => {
console.log(results) // See below the shape of result output
})
.catch((err) => {
// Error object
console.log(err)
})
```
The result contains the `fileName`, `matches`, and `count` of matches in the file.
```js
const result = {
fileName: 'src/users.js', // current working directory path is omitted
matches: [{
text: '// TODO: Add update user API', // line in found text
lineNumber: 5
}],
count: 1
}
```
### findTextInFiles
```js
import { findTextInFiles } from 'find-text'
/**
* findTextInFiles :: (String, String) => Promise
*
* Find the text in the files which are resided at the given directory.
*/
findTextInFiles('TODO', 'src/users.js')
.then((results) => {
console.log(results) // See below the shape of results output
})
.catch((err) => {
// Error object
console.log(err)
})
```
The results is an array of object (the output returned by `findText`)
```js
const results = [
{
fileName: 'src/users.js',
matches: [{
text: '// TODO: Add update user API',
lineNumber: 5
}],
count: 1
}
]
```
## API
### findText :: (String, String) => Promise
Find the text on the given file. When the text is not found in the given file, it returns empty object.
Promise is rejected when passing path which is not exist.
#### text
Type: `string`
The string you want to search for.
#### path
Type: `string`
The path you want to search in.
### findTextInFiles :: (String, String) => Promise
Find the text in the files which are resided at the given directory. It recursively reads the nested files which match for the pattern.
It returns empty array when passing not found text or no files are matched for the given pattern.
#### text
Type: `string`
The string you want to search for.
#### pattern
Type: `string`|`string[]`
Pattern to be matched. It supports negated pattern. For more information about pattern, check [micromatch](https://github.com/micromatch/micromatch)
## Changelog
This project adheres to [Semantic Versioning](http://semver.org/).
Every release, along with the migration instructions, is documented on the Github [Releases](https://github.com/denniscual/find-text/releases) page.
## License
[MIT](https://opensource.org/licenses/MIT)