npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jargon

v0.2.0

Published

ES6 component for string inflection/case/format/pluralization. Highly tested. Supports chaining.

Downloads

96

Readme

Jargon.js npm version license type npm downloads ECMAScript 6

ES6 component for string inflection/case/format/pluralization. Highly tested. Supports chaining.

import inflect from "jargon";

const myString = "Apple Sauce";

// Single String Transform
inflect(myString).snake.toString(); // "apple_sauce"

// Chained String Transforms
inflect(myString).snake.plural.toString(); // "apple_sauces"

Build Status ![Coverage Status](ht tps://coveralls.io/repos/FreeAllMedia/jargon/badge.svg) Code Climate Dependency Status Dev Dependency Status

Compatibility

Every single build and release is automatically tested on the following platforms:

node 0.12.x node 0.11.x node 0.10.x iojs 2.x.x iojs 1.x.x

Sauce Test Status

If your platform is not listed above, you can test your local environment for compatibility by copying and pasting the following commands into your terminal:

npm install jargon
cd node_modules/jargon
gulp test-local

Installation

Copy and paste the following command into your terminal to install Jargon:

npm install jargon --save

Import / Require

// ES6
import inflect from "jargon";
// ES5
var inflect = require("jargon");
// Require.js
define(["require"] , function (require) {
    var inflect = require("jargon");
});

Getting Started

Inflector Instances

The inflect() command returns an independent Inflector instance which allows one or more transforms to be completed, before returning the final string via .toString().

For example, the following two snippets are functionally equivalent:

Inline:

inflect("apple").plural.toString(); // apples

Progressive:

const inflector = inflect("apple");

inflector.plural;

inflector.toString(); // apples

Chaining Transforms

In addition to single transforms, Inflector instances support chaining of multiple transforms, such as in these two functionally equivalent examples:

Inline:

inflect("apple tree").plural.pascal.toString(); // AppleTrees

Progressive:

const inflector = inflect("apple tree");

inflector.plural;
inflector.pascal;

inflector.toString(); // AppleTrees

String Transforms

Each of these transforms can be chained together to perform more complex changes.

Plural

inflect("apple").plural.toString(); // apples

Camel

inflect("apple tree").camel.toString(); // appleTree

Pascal

inflect("apple_tree").pascal.toString(); // AppleTree

Snake

inflect("appleTree").snake.toString(); // apple_tree

Foreign Key

inflect("appleTree").foreignKey.toString(); // apple_tree_id

Table

inflect("AppleTree").table.toString(); // apple_trees

How to Contribute

See something that could use improvement? Have a great feature idea? We listen!

You can submit your ideas through our issues system, or make the modifications yourself and submit them to us in the form of a GitHub pull request.

We always aim to be friendly and helpful.

Running Tests

It's easy to run the test suite locally, and highly recommended if you're using Jargon.js on a platform we aren't automatically testing for.

npm test

SauceLabs Credentials

We've setup our tests to automatically detect whether or not you have our saucelabs credentials installed in your environment (process.env.SAUCE_USERNAME).

If our saucelabs credentials are not installed, the tests are setup to automatically detect all browsers you have installed on your local system, then use them to run the tests.

Obtaining Our SauceLabs Credentials

If you'd like to develop Jargon.js using SauceLabs, you need only create a new entry in our issue tracker asking for our SauceLabs credentials.

We'll send over all credentials specific to this project so that you can perform comprehensive cross-platform tests.

Public Shared Floobits Workspace

Whenever we're working on Jargon.js, we connect to a public workspace on FlooBits that lets you see and interact with the developers. Feel free to stop by, say hello, and offer suggestions!

https://floobits.com/fam-operations/jargon