1.0.1 • Published 4 years ago

imagine-in v1.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

imagine-in 🤔💭

Build Coverage Status License Dependencies Current Year

A simple package for when you need a little help expressing yourself.

Installation

Please follow these steps exactly. Failure to complete every step of this installation guide exactly as it is written could result in imagine-in not working! If you run in to issues, I guarantee that installing imagine-in is where you went wrong.

Step 1:

npm i imagine-in

Recommended Usage

According to Senior Software Engineer(s) working at FAANG companies (whose identities will remain anonymous), "imagine" statements can often be employed with great effect when trying to avoid performing tasks or using technologies that are undesirable. Examples include (but are not limited to):

  • using Angular
  • using Redux
  • having standup

Similarly, you can negate a statement to express preference:

  • not using TypeScript
  • not using Svelte

imagine-in makes expressing these sentiments easier than ever. To get started, you'll want to import imagine-in's top-level API.

import imagine from 'imagine-in';

Then, give it a value you want to transform.

imagine('using Angular');
// -> "Imagine using Angular in 2020."

imagine('using Redux');
// -> "Imagine using Redux in 2020."

imagine('having stand-up');
// -> "Imagine having stand-up in 2020."

imagine('not using TypeScript');
// -> "Imagine not using TypeScript in 2020."

imagine('not using Svelte');
// -> "Imagine not using Svelte in 2020."

It is recommended (although not required) that the input string begin with the present progressive form of a verb. Spaces surrounding the main content of your string are added automatically by the exposed imagine() function, so you need not add them yourself!

Additionally, imagine() will coerce any input value to a string using JavaScript's built-in String() function. If you don't like the result of that coercion, do it yourself.

Contributing

This package is considered complete in its current form, so no contributions will be necessary. imagine('contributing to open-source projects');

If you want to contribute anyway, go ahead and make a PR.

1.0.1

4 years ago

1.0.0

4 years ago