Git Product home page Git Product logo

packages's Introduction

Styles

This repository contains a library of all officially supported styles for Vale. The benefits of using these styles over their original implementations include:

  • Improved support for markup, including the ability to ignore code and target only certain sections of text (e.g., checking headers for a specific capitalization style).
  • No need to install and configure npm (Node.js), pip (Python), or other language-specific tools. With Vale, you get all the functionality in a single, standalone binary available for Windows, macOS, and Linux.
  • Easily combine, mismatch, or otherwise customize each style.

Available styles

Microsoft
An implementation of the Microsoft Writing Style Guide.
Google
An implementation of the Google Developer Documentation Style Guide.
write-good
An implementation of the guidelines enforced by the write-good linter.
proselint
An implementation of the guidelines enforced by the proselint linter.
Joblint
An implementation of the guidelines enforced by the Joblint linter.
alex
An implementation of the guidelines enforced by the alex linter.
Readability
An implementations of many popular "readability" metrics.

Requirements

All styles in this library must (1) be maintained in their own (dedicated) repository, (2) publish releases following Semantic Versioning, and (3) include a meta.json file with the following structure:

{
  "feed": "...",
  "vale_version": "..."
}

where feed is an Atom-formatted release feed (e.g., https://github.com/<USER>/<REPO>/releases.atom) and vale_version is the minimum required Vale version (e.g., v1.0.0).

Submitting a style

Fork this repo, add an entry (in alphabetical order) to the library.json file, and submit a PR.

packages's People

Contributors

aireilly avatar gguillotte avatar jdkato avatar themr0c avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

packages's Issues

Including licenses in distributed package archives?

Thanks for vale!

It appears that (at least) the latest Microsoft and Google packages do not contain the LICENSE file from the repository in their distributed media.

Concretely, on this repo: this could be documented as an additional meta.json field (e.g. "license_files": ["path-to-license-file", "path-to-upstream-license-file"]) rather than expecting a specifically-named file. Checking that this key exists, and the references paths exist in the as-downloaded archive, could be automated for PR review.

After there is a documented approach, this would then be worthwhile to add to the "first-party" repackagings in this org, and encourage others (such as RedHat) to include this information.

As for those first-party ones (and the list of license files): attribution in the README is good, but it seems like distributing the upstream's additional documents (e.g. Microsoft's MIT, CC and ThirdParty) might actually be required to meet the intent of the license granted to downstreams, even if a hard requirement isn't triggered by this manner of derived work in all cases.

Motivation: I am interested in re-re-packaging some of these archives for conda-forge (as well as integrating with our re-packaging of hunspell-en), which pretty much requires accurate attribution to be accepted. Assembling all these from source is... fine, but historically has been difficult to keep accurate at scale, whereas a convention-based approach (e.g. spacy-models) has worked well.

Actionables

Actionables for #1 :

  • Update docs to make it clear that a clone into StylesPath is supported (all the readme's suggest manual copying
  • Add this project which is more a comprehensive collection of styles: vale-styles

Jekyll, Gatsby, and Docusaurus packages

With the release of v2.16.0, it's now possible to create sharable configurations. This is particularly useful for providing a better out-of-the-box experience with popular site generators.

I've released the first version of such a package for Hugo, and I'd like to get 3 more released soon:

  • Jekyll
  • Gatsby
  • Docusaurus

Gatsby and Docusaurus should both probably inherit from a more general MDX package.

Consider splitsh

Would you consider moving vale style development here and then using something like splitsh
to create read-only mirrors? This would allow for a more integrated development workflow.
The reason I am requesting this is that the docs for errata-ai/Microsoft

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

That doesn't appear ideal in a git environment. If all the development was instead done here and the Microsoft directory was split into its own git mirror (without the tests etc), it would simply be a matter of using git submodules or git subtree commands to keep those rules updated (on the consumer side). Meanwhile, all the tests can exist here in this repo as the single source of truth.

Reference: https://github.com/splitsh/lite
This is used with success by the PHP symfony framework e.g. https://github.com/symfony/asset

Relationship to other package repositories in this org?

What is the relationship between this repository, and the other like-named repositories to those found in pkg?

Should this repo, or the specific other ones, be considered "canonical"?

It looks like they all accept PRs and cut releases (with seemingly unrelated version lines), so it's a bit hard to tell.

Request: enforce A vs An

Hi - I am looking for a way to check for when to use a vs an.

A interesting ... > incorrect
An interesting ... > correct

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.