Giter Club home page Giter Club logo

fitzgerald's Introduction

fitzgerald README

Fitzgerald is a Visual Studio Code extension that will analyse an active text document according to several readability metrics.

Features

Fitz uses the text-readability package to analyse the currently active text document and display an ease of reading score, a "Grade" score, a list of difficult words in the text and several other statistics.

fitz window

Running the extension

Fitz only depends on the text-readability package. Just npm install in the top level directory to install it.

The simplest way to run the extension is simply to open the top level directory in VSC and hit "debug". This should open an extension development host that has the extension installed.

To run the extension issue the command Fitz from the command palette. This should open a window displaying statistics for the current text file. The display will automatically update when you alter the text, make a selection or change editor windows.

Known Issues

  • Difficult word highlights will not be displayed correctly when there are multiple selections.
  • Testing is non-existent.

Fitzgerald?

After F. Scott Fitzgerald. The extension is partially inspired by [the Hemmingway editor][http://www.hemingwayapp.com] so the name was chosen to keep the "lost generation" theme going.

fitzgerald's People

Contributors

jaimz avatar

Watchers

 avatar James Cloos avatar

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.