string-is

string.is/ is an open-source, privacy-friendly toolkit for developers.

Getting Started

Install dependencies:

yarn install

Then run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

To run all linting checks, type checks, tests, and build for production:

yarn all

Adding a new converter

1. Decide what formats you are converting from and to. As an example, let's pretend you are writing a converter from plain text to reversed-text.
2. Check that there is an identity (under src/lib/identities) for the from format. In this case we are converting from plain text, and we already have a PlainIdentity, so we don't need to add a new identity. An identity should export (a) a confidence function which, given an input string, returns a number out of 100 describing the confidence that the given input matches the identity, and (b) an array of converters that the identity can be used with.
3. If you added a new identity in step (2), make sure to add it to the list of available identities in src/lib/identities/index.ts.
4. Check that there is an output (under src/lib/outputs) for the to format. An output should should export an output function which, given an input string (or possibly object, depending on the conversion taking place) and an options object, will convert the input into the desired output string.
5. If you added a new output in step (4), make sure to export it in src/lib/outputs/index.ts.
6. Add a new converter (under src/lib/converters) for the input + output combination. A converter should export (a) an operation function which passes the input string and an options object to the appropriate output, and (b) an outputId, which identifies which output is being used (this is needed later to decide which component to render to display the conversion). Make sure to export your new converter in src/lib/converters/index.ts after you have added it.
7. If you defined a new outputId in step (6), add a React output component (under src/components/domain/convert/outputs) to render the new kind of output. If you are re-using an existing kind of output (eg. converting to JSON or YAML) you can re-use an existing output here.
8. If you added a new React component in step (7), make sure to add it to the list of available components in src/components/domain/convert/outputs.

If all of the appropriate inputs, outputs, converters and React components are in place and exported correctly, you should be able to use your new converter, given the appropriate input string that triggers a non-zero confidence.

Deployment

The easiest way to deploy string.is is to use the Vercel Platform.

Check out their Next.js deployment documentation for more details.

Contributing

Once you've made your commits:

1. Fork string-is
2. Create a topic branch - git checkout -b feature/add-my-new-converter
3. Push to your branch - git push origin feature/add-my-new-converter
4. Create a Pull Request from your branch
5. That's it!

Author

Dave Perrett :: [email protected] :: @daveperrett

Licensing

See License.txt for details.