## RiTa: tools for computational writing RiTa is implemented in JavaScript and Java, with a common [API](https://github.com/dhowe/rita4j/blob/master/README.md#api) for both, and is free/libre/open-source. ### Features in v3.0 * Smart lexicon search for words matching part-of-speech, syllable, stress and rhyme patterns * Fast, heuristic algorithms for inflection, conjugation, stemming, tokenization, and more * Letter-to-sound engine for feature analysis of arbitrary words (with/without lexicon) * Integration of the [RiScript](https://observablehq.com/@dhowe/riscript) scripting language, designed for writers, now built with the blazing fast [Chevrotain](https://chevrotain.io/) parser * New options for generation via grammars and Markov chains * Published in ESM, CommonJS and as an IIFE Note: version 3.0 contains breaking changes -- please check the [release notes](https://rednoise.org/rita/#whats-new) ### Installation * For [esm](#an-esm-browser-sketch): ```import { RiTa } from "https://esm.sh/rita";``` * For [node](#with-nodejs-and-npm): `$ npm install rita` ```let { RiTa } = require('rita');``` * For [browsers](#a-simple-browser-sketch): `````` * For [p5.js](#with-p5js): `````` * For [developers](#developing) ### Example ```javascript import { RiTa } from "https://esm.sh/rita"; // to analyze a sentence let data = RiTa.analyze("The elephant took a bite!"); console.log(data); // to load a grammar let grammar = RiTa.grammar(rulesObjectOrJSON); console.log(grammar.expand()); ``` ## API

RiTa		RiMarkov	RiGrammar
RiTa.addTransform() RiTa.alliterations() RiTa.analyze() RiTa.concordance() RiTa.conjugate() RiTa.evaluate() RiTa.grammar() RiTa.hasWord() RiTa.isAbbrev() RiTa.isAdjective() RiTa.isAdverb() RiTa.isAlliteration() RiTa.isNoun() RiTa.isPunct() RiTa.isQuestion() RiTa.isStopWord() RiTa.isRhyme() RiTa.isVerb() RiTa.kwic() RiTa.markov()	RiTa.pastPart() RiTa.phones() RiTa.pos() RiTa.posInline() RiTa.presentPart() RiTa.pluralize() RiTa.randomOrdering() RiTa.randomSeed() RiTa.randomWord() RiTa.rhymes() RiTa.search() RiTa.sentences() RiTa.singularize() RiTa.soundsLike() RiTa.spellsLike() RiTa.stem() RiTa.stresses() RiTa.syllables() RiTa.tokenize() RiTa.untokenize()	addText() completions() generate() probability() probabilities() size() toJSON() fromJSON()	addRule() expand() removeRule() setRules() toJSON() fromJSON()

## RiScript [RiScript](https://github.com/dhowe/riscript) (the minor language that powers RiTa) was designed specifically for writers working with code. RiScript primitives (choices, symbols, gates, transforms, etc) can be used as part of any RiTa [grammar](https://rednoise.org/rita/reference/RiTa/grammar/) or executed directly using [RiTa.evaluate](https://rednoise.org/rita/reference/RiTa/evaluate/). For more info, see this interactive [notebook](https://observablehq.com/@dhowe/riscript) on observable.
 
## Developing To install/build the library and run tests (with npm/mocha and node v14.x): ```sh $ git clone https://github.com/dhowe/ritajs.git $ cd ritajs $ npm install $ npm run build $ npm test ``` If all goes well, you should see a list of successful tests and find the library built in 'dist'
Please make contributions via [fork-and-pull](https://reflectoring.io/github-fork-and-pull/) - thanks! ---------------   ### Visual Studio Code Once you have things running with npm/mocha/tsup, you might also try [VSCode](https://code.visualstudio.com/). Here you can see the tests in the VSCode _Testing_ view   ## About * Author: [Daniel C. Howe](http://rednoise.org/daniel) * Web Site: [https://rednoise.org/rita](http://rednoise.org/rita) * Github Repo: [https://github.com/dhowe/rita](https://github.com/dhowe/rita) * Issues: [https://github.com/dhowe/rita/issues](https://github.com/dhowe/rita/issues) * Reference: [https://rednoise.org/rita/reference](http://rednoise.org/rita/reference) * RiScript: [https://github.com/dhowe/riscript](https://github.com/dhowe/riscript)   ## Quick Start #### A simple browser sketch Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser: ```html

``` #### An ESM browser sketch Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser: ```html

``` #### With [p5.js](http://p5js.org/) Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser: ```html ``` If you already have a sketch, simply add `` to your index.html to include RiTa. #### With [node.js](http://nodejs.org/) and [npm](https://www.npmjs.com/) To install: `$ npm install rita` ```javascript let RiTa = require('rita'); let data = RiTa.analyze("The elephant took a bite!"); console.log(data); ```   ## Contributors ### Code Contributors This project exists only because of the people who contribute. Thank you! ### Financial Contributors