Vale-compatible implementations of many popular "readability" metrics.

Readability

This repository contains a Vale-compatible implementation of many popular "readability" metrics.

Getting Started

Readability requires Vale >= 2.13.0.

Download the latest release, copy the "Readability" directory to your StylesPath, and include it in your configuration file:

# This goes in a file named either `.vale.ini` or `_vale.ini`.
StylesPath = path/to/some/directory
MinAlertLevel = warning # suggestion, warning or error

# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = Readability

See Usage for more information.

Owner
errata.ai
Innovative tools for collaborative writing.
errata.ai
Comments
  • Compile Error: unresolved reference 'NaN'

    Compile Error: unresolved reference 'NaN'

    Using Readability 0.1.0, I am running into the following error:

    $ cd .vale/styles && unzip Readability-0.1.0.zip
    Archive:  Readability-0.1.0.zip
       creating: Readability/
      inflating: Readability/GunningFog.yml  
      inflating: Readability/FleschKincaid.yml  
      inflating: Readability/ColemanLiau.yml  
      inflating: Readability/AutomatedReadability.yml  
      inflating: Readability/LIX.yml     
      inflating: Readability/SMOG.yml    
      inflating: Readability/FleschReadingEase.yml  
      inflating: Readability/meta.json   
    ./bin/find.sh | xargs -0 vale --config .vale.ini --minAlertLevel warning --output=.vale/templates/cli.tmpl --no-wrap
    E201 Invalid value provided [.vale/styles/Readability/ColemanLiau.yml:8:1]:
    
       7  
       8* condition: "> 9"
    
    script run: Compile Error: unresolved reference 'NaN'
            at (main):1:37
    
    Execution stopped with code 1.
    
  • Configuration options to adjust the thresholds for readability rules

    Configuration options to adjust the thresholds for readability rules

    I'm trying out Vale for use on internal documentation, and I think the readability targets are hard to hit when the text needs to use standard technical terminology. For example, I'd like to be able to set the target for Readability.FleschReadingEase to 60 rather than 70 from my .vale.ini

  • Update files in Readabilty/ directory

    Update files in Readabilty/ directory

    If I understand the setup process correctly, the extends parameter in each .yml file requires a certain value.

    Based on the current repo, when I run vale some.md file, I get the following error:

    Invalid value provided [/Users/mike/Repos/cobalt-product-public-docs/styles/Readability/FleschKincaid.yml:1:10]:
    
       1* extends: metric
       2  message: "Try to keep the Flesch–Kincaid grade level (%s) below 8."
       3  link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
    
    'extends' key must be one of [capitalization conditional consistency existence occurrence repetition substitution readability spelling sequence].
    

    I no longer get the error when I change metric to readability

  • Erroneous Coleman-Liau Index message

    Erroneous Coleman-Liau Index message

    The ColemanLiau definition specifies condition "> 9" but its message is "Try to keep the Coleman–Liau Index grade (%s) below 19".

    Thus users can get a warnings such as "Try to keep the Coleman–Liau Index grade (10) below 19".

    I suppose the condition is correct but the grade in the message is too high.

  • Unable to sync package

    Unable to sync package

    vale sync is unable to retrieve readability package

    ❯ vale --version
    vale version 2.16.0
    ❯ cat ~/.vale.ini
    StylesPath = .vale/styles
    MinAlertLevel = suggestion
    
    Packages = readability
    
    [*]
    BasedOnStyles = Vale, readability
    
    ❯ vale sync
    Downloading packages [0/1] █     0% | 0sGet "readability": unsupported protocol scheme ""
    
  • Fix Coleman–Liau warning message

    Fix Coleman–Liau warning message

    Condition for Coleman–Liau is < 9, but the message is for 'below 19'. Given it's supposed to be a measure of grades, I assume it's the warning message that's in error.

  • Can't install Vale 2.13.0 using Chocolatey and no VS Code automatic check

    Can't install Vale 2.13.0 using Chocolatey and no VS Code automatic check

    When I run: choco upgrade vale it installs Vale v.2.10.0, not the latest Vale 2.13.0 required for readability check. Also, when I finally replaced vale.exe manually in the Chocolatey bin folder on Windows and tried to check the Markdown file in VS Code using the Vale extension, it doesn't show readability scores in the Problems tab. I had to run vale myfilename.md to see the PowerShell output for the readability.

A go library to improve readability in terminal apps using tabular data

uitable uitable is a go library for representing data as tables for terminal applications. It provides primitives for sizing and wrapping columns to i

Dec 30, 2022
Vale is a command-line tool that brings code-like linting to prose
Vale is a command-line tool that brings code-like linting to prose

Vale: Your style, our editor Vale is a command-line tool that brings code-like linting to prose. It's fast, cross-platform (Windows, macOS, and Linux)

Jan 3, 2023
Sensu-go-postgres-metrics - The sensu-go-postgres-metrics is a sensu check that collects PostgreSQL metrics

sensu-go-postgres-metrics Table of Contents Overview Known issues Usage examples

Jan 12, 2022
The metrics-agent collects allocation metrics from a Kubernetes cluster system and sends the metrics to cloudability

metrics-agent The metrics-agent collects allocation metrics from a Kubernetes cluster system and sends the metrics to cloudability to help you gain vi

Jan 14, 2022
Simple key-value store abstraction and implementations for Go (Redis, Consul, etcd, bbolt, BadgerDB, LevelDB, Memcached, DynamoDB, S3, PostgreSQL, MongoDB, CockroachDB and many more)

gokv Simple key-value store abstraction and implementations for Go Contents Features Simple interface Implementations Value types Marshal formats Road

Dec 24, 2022
Implementations of the Coconut signing scheme, cross-compatible between Rust and Go.

Coconut Coconut [paper] is a distributed cryptographic signing scheme providing a high degree of privacy for its users. You can find an overview of ho

Dec 9, 2022
The dynamic infrastructure framework for everybody! Distribute the workload of many different scanning tools with ease, including nmap, ffuf, masscan, nuclei, meg and many more!
The dynamic infrastructure framework for everybody! Distribute the workload of many different scanning tools with ease, including nmap, ffuf, masscan, nuclei, meg and many more!

Axiom is a dynamic infrastructure framework to efficiently work with multi-cloud environments, build and deploy repeatable infrastructure focussed on

Dec 30, 2022
Count once - Just once? no, when appear many it run once, but it can run many times

countOnce just once? no, when appear many it run once, but it can run many times

Jan 29, 2022
Telemetry interfaces for logs and metrics allowing complete decoupling of instrumentation implementations.

Telemetry This package provides a set of Telemetry interfaces allowing you to completely decouple your libraries and packages from Logging and Metrics

Aug 9, 2022
✨ #PTerm is a modern go module to beautify console output. Featuring charts, progressbars, tables, trees, and many more 🚀 It's completely configurable and 100% cross-platform compatible.
✨ #PTerm is a modern go module to beautify console output. Featuring charts, progressbars, tables, trees, and many more 🚀 It's completely configurable and 100% cross-platform compatible.

?? PTerm | Pretty Terminal Printer A golang module to print pretty text Show Demo Code PTerm.sh | Installation | Documentation | Quick Start | Example

Dec 27, 2022
A go library to improve readability in terminal apps using tabular data

uitable uitable is a go library for representing data as tables for terminal applications. It provides primitives for sizing and wrapping columns to i

Dec 30, 2022
It is a proxy to improve article readability, a directory for your favorite articles, and a way to make the internet lighter and more accessible.

timoneiro It is a work in progress. Some features are unimplemented yet. The helmsman's goal is to be a way to browse articles without all the distrac

Jun 13, 2022
Flesch-go - Go-based implementation of the Flesch reading ease readability formula module.

flesch-go Go-based implementation of the Flesch reading ease readability formula module. Thanks for the flesch-index project. Installation Run the fol

Nov 9, 2022
A Hacker News reader focused on content and readability.

HN.HSBLHSN.ME A HackerNews reader written in Go and React. It focuses on content and readability. Demo You can check the final result here at https://

Oct 16, 2022
The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.

The open-source platform for monitoring and observability. Grafana allows you to query, visualize, alert on and understand your metrics no matter wher

Jan 3, 2023
Read metrics from a Message Queue in Json format and expose them in a Prometheus compatible format

mq2prom Read metrics from a Message Queue in Json format and expose them in a Prometheus compatible format. Currently only works for MQTT compatible M

Jan 24, 2022
Prometheus metrics for Go database/sql via VictoriaMetrics/metrics

sqlmetrics Prometheus metrics for Go database/sql via VictoriaMetrics/metrics Features Simple API. Easy to integrate. Install Go version 1.16+ go get

Dec 16, 2022
Go http.RoundTripper that emits open telemetry metrics. This helps you easily get metrics for all external APIs you interact with.

go-otelroundtripper This package provides an easy way to collect http related metrics (e.g Response times, Status Codes, number of in flight requests

Jan 8, 2023