https://github.com/joellefkowitz/syllable-counter

Syllable counter tree view VSCode extension.
https://github.com/joellefkowitz/syllable-counter

counter syllable

Last synced: 6 months ago
JSON representation

Syllable counter tree view VSCode extension.

• Host: GitHub
• URL: https://github.com/joellefkowitz/syllable-counter
• Owner: JoelLefkowitz
• License: mit
• Created: 2020-08-20T15:22:58.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-27T19:35:58.000Z (about 2 years ago)
• Last Synced: 2024-10-04T21:41:16.686Z (almost 2 years ago)
• Topics: counter, syllable
• Language: TypeScript
• Homepage:
• Size: 12.4 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Syllable counter

Syllable counter tree view VSCode extension.

Counts and displays the number of syllables per line in the active document.

![Review](https://img.shields.io/github/actions/workflow/status/JoelLefkowitz/syllable-counter/review.yaml)

![Version](https://img.shields.io/npm/v/syllable-counter)

![Downloads](https://img.shields.io/npm/dw/syllable-counter)

![Size](https://img.shields.io/bundlephobia/min/syllable-counter)

![Quality](https://img.shields.io/codacy/grade/f5f5ce45a1594391abde33a206f53d84)

![Coverage](https://img.shields.io/codacy/coverage/f5f5ce45a1594391abde33a206f53d84)

## Example

![Example](docs/images/example.gif)

## Installing

```bash

npm install syllable-counter

```

## Documentation

Documentation and more detailed examples are hosted on [Github Pages](https://joellefkowitz.github.io/syllable-counter).

## Tooling

### Dependencies

To install dependencies:

```bash

yarn install

```

### Tests

To run tests:

```bash

yarn test

```

### Documentation

To generate the documentation locally:

```bash

yarn docs

```

### Linters

To run linters:

```bash

yarn lint

```

### Formatters

To run formatters:

```bash

yarn format

```

## Contributing

Please read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.

This repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).

Bump2version is used to version and tag changes. For example:

```bash

bump2version patch

```

### Contributors

- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work

## Remarks

Lots of love to the open source community!