react-headless-mde 1.0.0 → 1.0.2

package/.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.json'], // Specify it only for TypeScript files
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: ['plugin:react/recommended', 'standard-with-typescript', 'plugin:prettier/recommended'],
+  overrides: [],
+  plugins: ['react', 'import', 'simple-import-sort'],
+  rules: {
+    '@typescript-eslint/strict-boolean-expressions': 0,
+    '@typescript-eslint/explicit-function-return-type': 0,
+  },
+};

package/.github/workflows/npm-publish.yml

@@ -4,11 +4,11 @@
 name: Publish
 
 on:
-  push:
-    branches:
-      - 'main'
-#  release:
-#    types: [created]
+  release:
+    types: [created]
+#  push:
+#    branches:
+#      - 'main'
 
 jobs:
   build-and-publish:
@@ -22,5 +22,6 @@ jobs:
       - run: npm install
       - run: npm run build
       - run: npm publish
+        #      - run: npm publish --tag next
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+node_modules/.bin/lint-staged

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run check-types

package/README.md

@@ -1,6 +1,6 @@
-Introduction 
-===
-A simple yet powerful and extensible **React Markdown Editor** that aims to have feature parity with the Github Markdown editor. 
+# Introduction
+
+A simple yet powerful and extensible **React Markdown Editor** that aims to have feature parity with the Github Markdown editor.
 React-mde-headless has no 3rd party dependencies.
 
 ## [Demo](https://codesandbox.io/s/competent-jepsen-qyz51q?file=/src/index.tsx)
@@ -12,55 +12,63 @@ React-mde-headless has no 3rd party dependencies.
 ## Using
 
 ```jsx
-import {
- boldCommand,
- italicCommand,
- linkCommand,
- useTextAreaMarkdownEditor,
-} from 'react-mde-headless';
+import { bold, italic, link, useTextAreaMarkdownEditor } from 'react-mde-headless';
 
 export const MarkdownEditor = () => {
-  const { ref, commandController } = useTextAreaMarkdownEditor({
-    commandMap: {
-      bold: boldCommand, 
-      italic: italicCommand,
-      link: linkCommand,
-    },
-  });
- 
+  const { ref } = useTextAreaMarkdownEditor();
+
   return (
-    <div className={'mb-4'}>
-      <div className={'mb-3 gap-1 flex flex-wrap'}>
-        <button
-          onClick={() => {
-           commandController.executeCommand('bold')
-          }}        
-        >B</button>
-      </div>
+    <div>
+      <button onClick={bold}>B</button>
 
       <textarea ref={ref} />
-  </div>
+    </div>
   );
 };
 ```
+
+## Supported commands
+
+- bold
+- italic
+- strikethrough
+- headingLevel1
+- headingLevel2
+- headingLevel3
+- headingLevel4
+- headingLevel5
+- headingLevel6
+- link
+- quote
+- code
+- codeBlock
+- checkedList
+- orderedList
+- unorderedList
+- image
+- attachment
+
 ## Todo
 
-### Add to awesome-react-headless-components on stable version
-https://github.com/jxom/awesome-react-headless-components
+- Check execution on SSR (For example, Next.js) and, if necessary, regenerate eslint config, taking into account execution on node.js
+- Add to awesome-react-headless-components on stable version https://github.com/jxom/awesome-react-headless-components
+- peerDependencies React?
+- heading undo
 
 ### Third party
+
 - https://github.com/grassator/insert-text-at-cursor by https://twitter.com/d_kubyshkin
 
 ### XSS concerns
 
 React-mde-headless does not automatically sanitize the HTML preview. If your using Showdown,
-this has been taken from [their documentation](https://github.com/showdownjs/showdown/wiki/Markdown's-XSS-Vulnerability-(and-how-to-mitigate-it)):
+this has been taken from [their documentation](<https://github.com/showdownjs/showdown/wiki/Markdown's-XSS-Vulnerability-(and-how-to-mitigate-it)>):
 
 > Cross-side scripting is a well known technique to gain access to private information of the users
-of a website. The attacker injects spurious HTML content (a script) on the web page which will read
-the user’s cookies and do something bad with it (like steal credentials). As a countermeasure,
-you should filter any suspicious content coming from user input. Showdown doesn’t include an
-XSS filter, so you must provide your own. But be careful in how you do it…
+> of a website. The attacker injects spurious HTML content (a script) on the web page which will read
+> the user’s cookies and do something bad with it (like steal credentials). As a countermeasure,
+> you should filter any suspicious content coming from user input. Showdown doesn’t include an
+> XSS filter, so you must provide your own. But be careful in how you do it…
 
 You might want to take a look at [showdown-xss-filter](https://github.com/VisionistInc/showdown-xss-filter).
 
@@ -68,7 +76,6 @@ You might want to take a look at [showdown-xss-filter](https://github.com/Vision
 
 React-mde-headless is [MIT licensed](https://github.com/andrerpena/react-mde/blob/master/LICENSE).
 
-## About the author
-
-Made with :heart: by André Pena and [other awesome contributors](https://github.com/andrerpena).
+## About the authors
 
+Created by [André Pena](https://github.com/andrerpena). Maintained and developed by https://github.com/webbrother.