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

@squiz/formatted-text-editor

v2.5.0

Published

This repo contains the necessary code to develop and publish an NPM package for creating formatted text editors for use in Squiz products.

Downloads

2,475

Readme

DXP Formatted text editor component

This repo contains the necessary code to develop and publish an NPM package for creating formatted text editors for use in Squiz products.

The formatted text editor is using the Remirror React library.

Requirements

Working locally

Provided you have Volta installed as soon as you are in the formatted-text-editor directory you should be on the correct Node version. See the package.json for the specific version.

Now run the following commands from the packages/formatted-text-editor/ directory.

npm i
npm run dev

This will expose http://localhost:5173/ and this can be viewed in the browser.

TIP: Make sure you have already installed the node modules at the root level of the repo.

WIP: Contributing

Testing

Tests must be written when contributing to this package. Tests are automatically run in CI and test failure will result in unmerged code.

Unit testing

This package using Jest to perform Unit testing. In addition to Jest we are using a few Testing Library utilities:

Tests should be co-located with componentry and should strive for maximum coverage.

To run tests locally you can run:

npm run test

Or if you'd like to "watch" for changes:

npm run test:watch

When testing text input in the text editor, it is recommended to use the <MockEditor /> component, which is a simple wrapper around the Remirror component that provides additional functionality for testing (supplying text into the editor).

Test coverage

Test coverage is enforced globally in this package. You can run the test coverage script from the package root:

npm run test:coverage

Coverage will also run as part of the normal test script. Please see ./jest.config.ts for the currently configured thresholds.

End to end testing

This package uses Cypress for end to end testing.

To run tests locally you can run:

npm run test:e2e

Cypress is configured to look at a preview dev environment on http://localhost:8080.