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

@monaco-editor-enhancer/json-editor

v1.1.2

Published

Enhance your Monaco Editor with advanced JSON schema support, including Zod schema integration.

Downloads

212

Readme

@monaco-editor-enhancer/json-editor

NPM Version NPM Downloads NPM License

Enhance your Monaco Editor with advanced JSON schema support, including Zod schema integration.

Features

  • Seamless integration with Monaco Editor
  • Support for remote JSON schemas (HTTP/HTTPS)
  • Integration with Zod schemas
  • Custom JSON schema support
  • Flexible schema validation options
  • Easy-to-use Higher-Order Components (HOCs) for quick integration

Installation

npm add @monaco-editor-enhancer/json-editor
pnpm add @monaco-editor-enhancer/json-editor
yarn add @monaco-editor-enhancer/json-editor
bun add @monaco-editor-enhancer/json-editor

Usage

Basic Usage with withJsonEditor

import { Editor } from '@monaco-editor/react';
import { withJsonEditor } from '@monaco-editor-enhancer/json-editor';
import { z } from 'zod';

const JsonEditor = withJsonEditor(Editor, 'onMount');

const schema = z.object({
  name: z.string(),
  age: z.number(),
});

const App = () => {
  return <JsonEditor height={320} schemaUri='zod://user' schemaContent={schema} />;
};

Advanced Usage with withMonacoJsonEditor

import { Editor, type EditorProps } from '@monaco-editor/react';
import { withMonacoJsonEditor } from '@monaco-editor-enhancer/json-editor';
import { z } from 'zod';

const JsonEditor = withMonacoJsonEditor<EditorProps>((initEditor, props) => (
  <Editor
    {...props}
    onMount={(editor, monaco) => {
      initEditor(monaco, editor.getModel());
      props.onMount?.(editor, monaco);
    }}
  />
));

const schema = z.object({
  name: z.string(),
  age: z.number(),
});

const App = () => {
  return <JsonEditor height={320} schemaUri='zod://user' schemaContent={schema} />;
};

API

The library provides two main HOCs:

  1. withJsonEditor: A simplified HOC for quick integration.
  2. withMonacoJsonEditor: A more flexible HOC for advanced use cases.

Both HOCs create components that accept the following props:

  • schemaUri: A string specifying the type and location of the schema. Can be one of:
    • http:// or https://: For remote JSON schemas
    • json-schema://: For local JSON schemas
    • zod://: For Zod schemas
  • schemaContent: The actual schema content (for Zod and local JSON schemas)
  • schemaRequestService: (Optional) A custom function to fetch remote schemas
  • schemaValidation: (Optional) Validation mode: 'error', 'warning', or 'ignore'
  • tabSize: (Optional) The size of a tab in spaces

All other props are passed through to the underlying Monaco Editor component.

Schema Types

  1. Remote JSON Schema:

    <JsonEditor schemaUri='https://example.com/schema.json' schemaValidation='error' />
  2. Local JSON Schema:

    const mySchema = {
      type: 'object',
      properties: {
        name: { type: 'string' },
        age: { type: 'number' },
      },
    };
    
    <JsonEditor schemaUri='json-schema://myschema' schemaContent={mySchema} />;
  3. Zod Schema:

    import { z } from 'zod';
    
    const zodSchema = z.object({
      name: z.string(),
      age: z.number(),
    });
    
    <JsonEditor schemaUri='zod://myschema' schemaContent={zodSchema} />;

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.