@brackson/strapi-code-editor-custom-field v0.2.5

Strapi plugin strapi-code-editor-custom-field

Code editor plugin for strapi CMS. It uses the monaco editor (vscode).

Installation

You need install also monaco editor.

yarn add monaco-editor monaco-editor-webpack-plugin strapi-code-editor-custom-field

npm install monaco-editor monaco-editor-webpack-plugin strapi-code-editor-custom-field

You must add plugin to config/plugins.js file.

{
  ...
  'strapi-code-editor-custom-field': {
    enabled: true,
  },
  ...
}

You need to update the config/middlewares.ts file. Replace strapi::security with

{
  name: 'strapi::security',
  config: {
    contentSecurityPolicy: {
      useDefaults: true,
      directives: {
        'script-src-elem': ["'self'", 'cdn.jsdelivr.net'],
        upgradeInsecureRequests: null,
      },
    },
  },
},

This will add the cdn.jsdelivr.net to the script-src-elem directive for enabling content security policy.

And the last step is to add the monaco-editor-webpack-plugin to the src/admin/webpack.config.js file.

'use strict'

const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin')

module.exports = (config) => {
  config.plugins.push(new MonacoWebpackPlugin())

  return config
}

Last step is to rebuild the admin panel.

npm run build

OR

yarn build

Usage

When you add the plugin you will see two new custom fields. One for javascript (and other languages) and one for json.

The editor then will show up in content-type add/edit page.

JSON editor

Javascript editor

Editor can be opened in fullscreen mode.

Under the hood

Editor is using two different types for strapi field. When you select JSON editor it will be json type. When you select different language it will be text type.

In case of other language than json, the language is prefixed before value.

Language selector:

const languageRegExp = new RegExp('__(.+)__;')
const languageFromValue = value.match(languageRegExp)[1]

Remove language from value:

const languageRegExp = new RegExp('__(.+)__;')
const valueWithoutLanguage = value.replace(languageRegExp, '')

Issues

If you find any issues, please report them here.