# bolt-query

> Query info and files from your Bolt project

Latest version **1.1.4** (published 2017-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install bolt-query
pnpm add bolt-query
yarn add bolt-query
bun add bolt-query
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2017-10-03 |
| First published | 2017-09-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | James Kyle |
| Maintainers | thejameskyle |

## Links

- npm: https://www.npmjs.com/package/bolt-query
- Repository: https://github.com/bolt/bolt-query
- Homepage: https://github.com/bolt/bolt-query#readme
- Issues: https://github.com/bolt/bolt-query/issues
- npm.io page: https://npm.io/package/bolt-query

## Dependencies (4)

- [bolt](https://npm.io/package/bolt.md) ^0.13.0
- [globby](https://npm.io/package/globby.md) ^6.1.0
- [parse-json](https://npm.io/package/parse-json.md) ^3.0.0
- [typeable-promisify](https://npm.io/package/typeable-promisify.md) ^2.0.1

## Recent versions

- 1.1.4 (latest) — 2017-10-03
- 1.1.2 — 2017-09-26
- 1.1.1 — 2017-09-26
- 1.1.0 — 2017-09-26

## README

# bolt-query

> Query info and files from your Bolt project

```js
let results = await query({
  cwd: fixturePath,
  projectFiles: {
    readme: 'README.md',
    releases: 'releases/**/*.md',
  },
  workspaceFiles: {
    readme: 'README.md',
    docs: 'docs/**/*.md',
    examples: 'examples/**/*.js',
  },
});
```

```js
{
  dir: '/path/to/project',
  pkgPath: '/path/to/project/package.json',
  pkg: { name: 'project', pworkspaces: ['packages/*'], version: '1.0.0' },
  files: {
    readme: [
      { filePath: '/path/to/project/README.md', fileContents: '...' }
    ],
    releases: [
      { filePath: '/path/to/project/releases/introducing-fixture.md', fileContents: '...' },
      { filePath: '/path/to/project/releases/launching-1.0.md', fileContents: '...' }
    ],
  },
  workspaces: [{
    dir: '/path/to/project/packages/bar',
    pkgPath: '/path/to/project/packages/bar/package.json',
    pkg: { name: 'bar', version: '1.0.0' },
    files: {
      docs: [
        { filePath: '/path/to/project/packages/bar/docs/intro.md', fileContents: '...' }
      ],
      examples: [
        { filePath: '/path/to/project/packages/bar/examples/basic.js', fileContents: '...' }
      ],
      readme: [
        { filePath: '/path/to/project/packages/bar/README.md', fileContents: '...' }
      ],
    },
  }, {
    dir: '/path/to/project/packages/foo',
    pkgPath: '/path/to/project/packages/foo/package.json',
    pkg: { name: 'foo', version: '1.0.0' },
    files: {
      docs: [
        { filePath: '/path/to/project/packages/foo/docs/advanced/multiple.md', fileContents: '...' },
        { filePath: '/path/to/project/packages/foo/docs/intro.md', fileContents: '...' }
      ],
      examples: [
        { filePath: '/path/to/project/packages/foo/examples/advanced.js', fileContents: '...' },
        { filePath: '/path/to/project/packages/foo/examples/basic.js', fileContents: '...' }
      ],
      readme: [
        { filePath: '/path/to/project/packages/foo/README.md', fileContents: '...' }
      ]
    }
  }]
}
```

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