# style-search

> Search CSS(-like) strings

Latest version **0.1.0** (published 2016-06-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install style-search
pnpm add style-search
yarn add style-search
bun add style-search
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-06-12 |
| First published | 2016-06-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | separate (@types/style-search) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | David Clark |
| Maintainers | davidtheclark |
| Keywords | css, search, stylelint |

## Links

- npm: https://www.npmjs.com/package/style-search
- Repository: https://github.com/davidtheclark/style-search
- Homepage: https://github.com/davidtheclark/style-search#readme
- Issues: https://github.com/davidtheclark/style-search/issues
- npm.io page: https://npm.io/package/style-search

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2016-06-12

## README

# style-search [![CircleCI](https://circleci.com/gh/davidtheclark/style-search.svg?style=svg)](https://circleci.com/gh/davidtheclark/style-search)

Search CSS (and CSS-like) strings, with sensitivity to whether matches occur inside strings, comments, and functions.

## Usage

```js
var styleSearch = require('style-search');

styleSearch(options, callback);
```

**By default, the search ignores strings, comments, and function names.** You can use the options to change this behavior or introduce other restrictions. That is what makes this module more useful for many searches than `indexOf()` or a `RegExp`.

However, if you need more detailed parsing, you should consider using the real parsers [PostCSS](https://github.com/postcss/postcss), [`postcss-selector-parser`](https://github.com/postcss/postcss-selector-parser), and [`postcss-value-parser`](https://github.com/TrySound/postcss-value-parser).

### Example

```css
/* Here is some pink */
a { color: pink; }
a::before { content: "pink" }
b { color: shadesOfPink(7); }
```

```js
styleSearch({
  source: theCssStringAbove,
  target: "pink",
}, function(match, count) {
  /* Only the "pink" in `color: pink` will be
  reported as a match */
});
```

### Reporting matches

For every match found your `callback` is invoked. It is passed two arguments:

- A `match` object with the following properties:
  - `startIndex`: where the match begins
  - `endIndex`: where the match ends
  - `target`: what got matched (useful if your `target` option is an array instead of a single string)
  - `insideFunctionArguments`: whether the match is inside a function — *this includes the parentheses around the arguments*
  - `insideComment`: whether the match is inside a comment
  - `insideString`: whether the match is inside a string
- The count of how many matches have been found up to this point.

### Options

Below you'll see that syntax feature options all accept three keywords: `"skip"`, `"check"`, `"only"`. An error will be thrown if you use `"only"` more than once.

#### source

String. *Required.*

The source string to search through.

#### target

String or array of strings. *Required.*

The target of the search. Can be
- a single character
- a string with some length
- an array of strings, all of which count as matches (the `match` object passed to the `callback` will differentiate which string in the array got matched via its `target` property)

#### once

Boolean. Default: `false`.

If `true`, the search will stop after one match is found.

#### comments

`"skip"` | `"check"` | `"only"`. Default: `"skip"`.

This includes both standard `/* CSS comments */` and non-standard but widely used `// single line comments`.

#### strings

`"skip"` | `"check"` | `"only"`. Default: `"skip"`.

#### functionNames

`"skip"` | `"check"` | `"only"`. Default: `"skip"`.

#### functionArguments

`"skip"` | `"check"` | `"only"`. Default: `"check"`.

#### parentheticals

`"skip"` | `"check"` | `"only"`. Default: `"check"`.

This designates anything inside parentheses, which includes standard functions, but also Sass maps and other non-standard constructs. `parentheticals` is a broader category than `functionArguments`.

---
_Source: https://npm.io/package/style-search · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._