taila
Advanced tools
Comparing version 1.0.1 to 1.0.2
{ | ||
"name": "taila", | ||
"version": "1.0.1", | ||
"version": "1.0.2", | ||
"description": "This is a utility for tailing a text file similar to tail -f but with a few extra features", | ||
@@ -5,0 +5,0 @@ "main": "src/tail.js", |
@@ -10,2 +10,9 @@ # Tail with pattern matching and filtering | ||
## Get started | ||
Perform | ||
``` | ||
npm install taila -g | ||
``` | ||
## Basic usage | ||
@@ -39,2 +46,68 @@ | ||
For the command to work properly | ||
For the command to work properly it needs to have a list of patterns to search for. These patterns are configured in a file named .tailor.conf.js. | ||
The command first looks for the ocnfig file in the current working directory. If that fails it looks in the users home folder for the file. | ||
The file looks like this: | ||
```javascript | ||
module.exports = { | ||
highlights: [ | ||
{ | ||
pattern: "[ERROR]", | ||
re: false, | ||
bkg: "bgRed", | ||
color: "black" | ||
}, | ||
{ | ||
pattern: "DEBUG", | ||
color: "green" | ||
}, | ||
{ | ||
pattern: "INFO", | ||
color: "blue", | ||
} | ||
] | ||
}; | ||
``` | ||
The pattern is either a substring or a regular expression. The property re is a flag indikating oid the pattern string ia regular expression or substring. | ||
The colors have the following possible values: | ||
### Colors | ||
- `black` | ||
- `red` | ||
- `green` | ||
- `yellow` | ||
- `blue` *(On Windows the bright version is used since normal blue is illegible)* | ||
- `magenta` | ||
- `cyan` | ||
- `white` | ||
- `gray` ("bright black") | ||
- `redBright` | ||
- `greenBright` | ||
- `yellowBright` | ||
- `blueBright` | ||
- `magentaBright` | ||
- `cyanBright` | ||
- `whiteBright` | ||
### Background colors | ||
- `bgBlack` | ||
- `bgRed` | ||
- `bgGreen` | ||
- `bgYellow` | ||
- `bgBlue` | ||
- `bgMagenta` | ||
- `bgCyan` | ||
- `bgWhite` | ||
- `bgBlackBright` | ||
- `bgRedBright` | ||
- `bgGreenBright` | ||
- `bgYellowBright` | ||
- `bgBlueBright` | ||
- `bgMagentaBright` | ||
- `bgCyanBright` | ||
- `bgWhiteBright` |
606820
112