Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tunnckocore/flow-reporter-codeframe

⚡️ FlowType errors reporter similiar to ESLint's codeframe one :tada:
https://github.com/tunnckocore/flow-reporter-codeframe

cli codeframe error-reporting errors eslint flow flow-reporter flowtype reporter

Last synced: 23 days ago
JSON representation

⚡️ FlowType errors reporter similiar to ESLint's codeframe one :tada:

Host: GitHub
URL: https://github.com/tunnckocore/flow-reporter-codeframe
Owner: tunnckoCore
License: apache-2.0
Created: 2018-08-11T02:28:29.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2022-12-09T02:07:22.000Z (almost 2 years ago)
Last Synced: 2024-10-07T22:19:35.230Z (about 1 month ago)
Topics: cli, codeframe, error-reporting, errors, eslint, flow, flow-reporter, flowtype, reporter
Language: JavaScript
Homepage:
Size: 2.06 MB
Stars: 3
Watchers: 3
Forks: 1
Open Issues: 15
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # flow-reporter-codeframe [![npm version][npmv-img]][npmv-url] [![github release][ghrelease-img]][ghrelease-url] [![License][license-img]][license-url]

> [@FlowType](https://flow.org) errors reporter similiar to ESLint's codeframe one



[![Code style][codestyle-img]][codestyle-url]

[![CircleCI linux build][linuxbuild-img]][linuxbuild-url]

[![CodeCov coverage status][codecoverage-img]][codecoverage-url]

[![DavidDM dependency status][dependencies-img]][dependencies-url]

[![Renovate App Status][renovateapp-img]][renovateapp-url]

[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]

[![Semantically Released][new-release-img]][new-release-url]

If you have any _how-to_ kind of questions, please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents.  

For bugs reports and feature requests, [please create an issue][open-issue-url] or ping [@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter.

[![Conventional Commits][ccommits-img]][ccommits-url]

[![Become a Patron][patreon-img]][patreon-url]

[![Share Love Tweet][shareb]][shareu]

[![NPM Downloads Weekly][downloads-weekly-img]][npmv-url]

[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url]

[![NPM Downloads Total][downloads-total-img]][npmv-url]

Project is [semantically](https://semver.org) & automatically released on [CircleCI][codecoverage-url] with [new-release][] and its [New Release](https://github.com/apps/new-release) GitHub App.



  

    

  



## Table of Contents

- [Install](#install)

- [CLI](#cli)

- [API](#api)

  * [flowReporter](#flowreporter)

  * [.getDefaultOptions](#getdefaultoptions)

- [Contributing](#contributing)

  * [Follow the Guidelines](#follow-the-guidelines)

  * [Support the project](#support-the-project)

  * [OPEN Open Source](#open-open-source)

  * [Wonderful Contributors](#wonderful-contributors)

- [License](#license)

## Install

This project requires [**Node.js**](https://nodejs.org) **>=6.0.0**. Install it using 

[**yarn**](https://yarnpkg.com) or [**npm**](https://npmjs.com).  

_We highly recommend to use Yarn when you think to contribute to this project._

```bash

$ yarn add flow-reporter-codeframe

```

## CLI

Use `flow check` or `flow focus-check filename.js` and the json formatter.

 ```

# general use

flow check --json --json-version 2 | flow-reporter-codeframe

 # or

cat report-file.txt | flow-reporter-codeframe

 # or generate report file

flow check --json --json-version 2 > flow-report.json

 # and pass that file to the reporter

flow-reporter-codeframe flow-report.json

```

 Optionally pass `--no-color` to disable colors - make note that we detect if it is

run on CI, so they are disabled there.

 Optionally, we can highlight the code, pass `--highlight-code` if you want to be more fancy. :)

If `--no-color` is passed, that's disabled automagically too.

## API

_Generated using [docks](http://npm.im/docks)._

### [flowReporter](/src/index.js#L43)

Formatting the `val` to look like ESLint's cool `codeframe` reporter.

It may be a bit more verbose and to have a bit more lines of code than

the Flow's default one, but that's not a bad thing.

You should provide valid report, which means that for now you are forced to

use `--json --json-version 2` flags if you want to use that reporter.

**Params**

- `val` **{string|object}** the Flow's JSON version 2 thingy, `--json` + `--json-version 2`

- `opts` **{object}** optional options `color` and `highlightCode`

**Returns**

- `Promise` resolves to a `string` if there is errors, `undefined` if no errors

**Examples**

```javascript

import execa from 'execa';

import reporter from 'flow-reporter-codeframe';

async function main() {

  try {

    await execa('flow', ['check', '--json', '--json-version', '2']);

  } catch (err) {

    const output = await reporter(err.stdout);

    console.log(output);

  }

}

main();

```

### [.getDefaultOptions](/src/index.js#L237)

Get default options for the reporter. By default,

we have colors turned on, and highlighting code turned off.

**Returns**

- `object` containing `{ color: boolean, highlightCode: boolean }`

**Examples**

```javascript

import { getDefaultOptions } from 'flow-reporter-codeframe';

console.log(getDefaultOptions());

// => { color: true, highlightCode: false }

```

**[back to top](#thetop)**

## Contributing

### Follow the Guidelines

Please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for 

advices.  

For bugs reports and feature requests, [please create an issue][open-issue-url] or ping 

[@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter.

### Support the project

[Become a Partner or Sponsor?][patreon-url] :dollar: Check the **Partner**, **Sponsor** or **Omega-level** tiers! :tada: You can 

get your company logo, link & name on this file. It's also rendered on package's page in [npmjs.com][npmv-url] and 

[yarnpkg.com](https://yarnpkg.com/en/package/flow-reporter-codeframe) sites too! :rocket:

Not financial support? Okey! [Pull requests](https://github.com/tunnckoCore/contributing#opening-a-pull-request), stars 

and all kind of [contributions](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute) are always 

welcome. :sparkles:

### OPEN Open Source

This project is following [OPEN Open Source](http://openopensource.org) model

> Individuals making significant and valuable contributions are given commit-access to the project to 

contribute as they see fit. This project is built on collective efforts and it's not strongly guarded by its founders.

There are a few basic ground-rules for its contributors

1. Any **significant modifications** must be subject to a pull request to get feedback from other contributors.

2. [Pull requests](https://github.com/tunnckoCore/contributing#opening-a-pull-request) to get feedback are 

_encouraged_ for any other trivial contributions, but are not required.

3. Contributors should attempt to adhere to the prevailing code-style and development workflow.

### Wonderful Contributors

Thanks to the hard work of these wonderful people this project is alive! It follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.  

Don't hesitate to add yourself to that list if you have made any contribution! ;) [See how, here](https://github.com/jfmengels/all-contributors-cli#usage).

| [
_{Charlike Mike Reagent}](https://tunnckocore.com)
[💻](https://github.com/olstenlarck/flow-reporter-codeframe/commits?author=olstenlarck "Code") [📖](https://github.com/olstenlarck/flow-reporter-codeframe/commits?author=olstenlarck "Documentation") [💬](#question-olstenlarck "Answering Questions") [👀](#review-olstenlarck "Reviewed Pull Requests") [🔍](#fundingFinding-olstenlarck "Funding Finding") |

| :---: |

Consider showing your [support](#support-the-project) to them. :sparkling_heart:

## License

Copyright (c) 2018-present, [contributors](#wonderful-contributors). Released under the [Apache-2.0 License][license-url].

---

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on August 11, 2018._

[npmv-url]: https://www.npmjs.com/package/flow-reporter-codeframe

[npmv-img]: https://badgen.net/npm/v/flow-reporter-codeframe?icon=npm

[ghrelease-url]: https://github.com/tunnckoCore/flow-reporter-codeframe/releases/latest

[ghrelease-img]: https://badgen.net/github/release/olstenlarck/flow-reporter-codeframe?icon=github

[license-url]: https://github.com/tunnckoCore/flow-reporter-codeframe/blob/master/LICENSE

[license-img]: https://badgen.net/npm/license/flow-reporter-codeframe

[codestyle-url]: https://github.com/tunnckoCore/eslint-config-esmc

[codestyle-img]: https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb

[linuxbuild-url]: https://circleci.com/gh/tunnckoCore/flow-reporter-codeframe/tree/master

[linuxbuild-img]: https://badgen.net/circleci/github/tunnckoCore/flow-reporter-codeframe/master?label=build&icon=circleci

[codecoverage-url]: https://codecov.io/gh/tunnckoCore/flow-reporter-codeframe

[codecoverage-img]: https://badgen.net/codecov/c/github/tunnckoCore/flow-reporter-codeframe?icon=codecov

[dependencies-url]: https://david-dm.org/tunnckoCore/flow-reporter-codeframe

[dependencies-img]: https://badgen.net/david/dep/tunnckoCore/flow-reporter-codeframe?label=deps

[ccommits-url]: https://conventionalcommits.org/

[ccommits-img]: https://badgen.net/badge/conventional%20commits/v1.0.0/dfb317

[new-release-url]: https://github.com/tunnckoCore/new-release

[new-release-img]: https://badgen.net/badge/semantically/released/05c5ff

[downloads-weekly-img]: https://badgen.net/npm/dw/flow-reporter-codeframe

[downloads-monthly-img]: https://badgen.net/npm/dm/flow-reporter-codeframe

[downloads-total-img]: https://badgen.net/npm/dt/flow-reporter-codeframe

[renovateapp-url]: https://renovatebot.com

[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green

[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green

[prs-welcome-url]: http://makeapullrequest.com

[paypal-donate-url]: https://paypal.me/tunnckoCore/10

[paypal-donate-img]: https://badgen.net/badge/$/support/purple

[patreon-url]: https://www.patreon.com/bePatron?u=5579781

[patreon-img]: https://badgen.net/badge/patreon/tunnckoCore/F96854?icon=patreon

[patreon-sponsor-img]: https://badgen.net/badge/become/a%20sponsor/F96854?icon=patreon

[shareu]: https://twitter.com/intent/tweet?text=https://github.com/olstenlarck/flow-reporter-codeframe&via=tunnckoCore

[shareb]: https://badgen.net/badge/twitter/share/1da1f2?icon=twitter

[open-issue-url]: https://github.com/olstenlarck/flow-reporter-codeframe/issues/new

[author-link]: https://tunnckocore.com

[new-release]: https://github.com/tunnckoCore/new-release