@atlaskit/editor-plugin-code-bidi-warning 8.0.21 → 8.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +14 -10
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @atlaskit/editor-plugin-code-bidi-warning
2
2
 
3
+ ## 8.0.23
4
+
5
+ ### Patch Changes
6
+
7
+ - [`27529d2f5ddfe`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/27529d2f5ddfe) -
8
+ Update README.md and 0-intro.tsx
9
+ - Updated dependencies
10
+
11
+ ## 8.0.22
12
+
13
+ ### Patch Changes
14
+
15
+ - [`82c0224977f47`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/82c0224977f47) -
16
+ Update README.md and 0-intro.tsx
17
+ - Updated dependencies
18
+
3
19
  ## 8.0.21
4
20
 
5
21
  ### Patch Changes
package/README.md CHANGED
@@ -1,23 +1,31 @@
1
- # Editor plugin code bidi warning
1
+ # Editor Plugin Code Bidi Warning
2
2
 
3
3
  Code bidi warning plugin for @atlaskit/editor-core
4
4
 
5
5
  **Note:** This component is designed for internal Atlassian development.
6
6
  External contributors will be able to use this component but will not be able to submit issues.
7
7
 
8
- ## Install
8
+ ## Overview
9
+
10
+ The Code Bidi Warning plugin detects and highlights bidirectional text characters in code blocks that may cause readability issues or security concerns. It provides visual warnings to help users identify potentially problematic code patterns.
11
+
12
+ ## Key features
13
+
14
+ - **Bidi character detection** - Automatically detect bidirectional text characters in code blocks
15
+ - **Visual warnings** - Display decorations and tooltips for identified bidi characters
16
+ - **Feature flag support** - Respect feature flags for enabling/disabling the warning functionality
17
+ - **Limited mode compatibility** - Disable warnings when the editor is in limited mode
18
+ - **Configurable appearance** - Support for different editor appearance modes
9
19
 
10
- ---
20
+ ## Install
11
21
 
12
- - **Install** - _yarn add @atlaskit/editor-plugin-code-bidi-warning_
22
+ - **Install** - *yarn add @atlaskit/editor-plugin-code-bidi-warning*
13
23
  - **npm** - [@atlaskit/editor-plugin-code-bidi-warning](https://www.npmjs.com/package/@atlaskit/editor-plugin-code-bidi-warning)
14
24
  - **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-code-bidi-warning)
15
25
  - **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-code-bidi-warning/dist/)
16
26
 
17
27
  ## Usage
18
28
 
19
- ---
20
-
21
29
  **Internal use only**
22
30
 
23
31
  @atlaskit/editor-plugin-code-bidi-warning is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
@@ -28,12 +36,8 @@ Please see [Atlaskit - Editor plugin code bidi warning](https://atlaskit.atlassi
28
36
 
29
37
  ## Support
30
38
 
31
- ---
32
-
33
39
  For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
34
40
 
35
41
  ## License
36
42
 
37
- ---
38
-
39
43
  Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-code-bidi-warning",
3
- "version": "8.0.21",
3
+ "version": "8.0.23",
4
4
  "description": "Code bidi warning plugin for @atlaskit/editor-core.",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",