@codemirror/search - npm Package Compare versions

Comparing version 0.19.6 to 0.19.7

CHANGELOG.md

@@ -0,1 +1,11 @@
+## 0.19.7 (2022-02-14)
+
+### Breaking changes
+
+`searchConfig` is deprecated in favor of `search` (but will exist until next major release).
+
+### New features
+
+The new `search` function is now used to enable and configure the search extension.
+
 ## 0.19.6 (2022-01-27)
@@ -2,0 +12,0 @@

dist/index.d.ts

@@ -193,5 +193,8 @@ import * as _codemirror_state from '@codemirror/state';
 /**
-Configure the behavior of the search extension.
+Add search state to the editor configuration, and optionally
+configure the search extension.
+([`openSearchPanel`](https://codemirror.net/6/docs/ref/#search.openSearchPanel) when automatically
+enable this if it isn't already on.)
 */
-declare function searchConfig(config: SearchConfig): Extension;
+declare function search(config?: SearchConfig): Extension;
 /**
@@ -251,3 +254,7 @@ A search query. Part of the editor's search state.
 /**
-A state effect that updates the current search query.
+A state effect that updates the current search query. Note that
+this only has an effect if the search state has been initialized
+(by including [`search`](https://codemirror.net/6/docs/ref/#search.search) in your configuration or
+by running [`openSearchPanel`](https://codemirror.net/6/docs/ref/#search.openSearchPanel) at least
+once).
 */
@@ -308,2 +315,2 @@ declare const setSearchQuery: _codemirror_state.StateEffectType<SearchQuery>;
 
-export { RegExpCursor, SearchCursor, SearchQuery, closeSearchPanel, findNext, findPrevious, getSearchQuery, gotoLine, highlightSelectionMatches, openSearchPanel, replaceAll, replaceNext, searchConfig, searchKeymap, selectMatches, selectNextOccurrence, selectSelectionMatches, setSearchQuery };
+export { RegExpCursor, SearchCursor, SearchQuery, closeSearchPanel, findNext, findPrevious, getSearchQuery, gotoLine, highlightSelectionMatches, openSearchPanel, replaceAll, replaceNext, search, searchKeymap, selectMatches, selectNextOccurrence, selectSelectionMatches, setSearchQuery };

dist/index.js

@@ -537,8 +537,15 @@ import { EditorView, Decoration, ViewPlugin, runScopeHandlers } from '@codemirror/view';
 /**
-Configure the behavior of the search extension.
+Add search state to the editor configuration, and optionally
+configure the search extension.
+([`openSearchPanel`](https://codemirror.net/6/docs/ref/#search.openSearchPanel) when automatically
+enable this if it isn't already on.)
 */
-function searchConfig(config) {
-    return searchConfigFacet.of(config);
+function search(config) {
+    return config ? [searchConfigFacet.of(config), searchExtensions] : searchExtensions;
 }
 /**
+@internal
+*/
+const searchConfig = search; // FIXME drop on next release
+/**
 A search query. Part of the editor's search state.
@@ -673,3 +680,7 @@ */
 /**
-A state effect that updates the current search query.
+A state effect that updates the current search query. Note that
+this only has an effect if the search state has been initialized
+(by including [`search`](https://codemirror.net/6/docs/ref/#search.search) in your configuration or
+by running [`openSearchPanel`](https://codemirror.net/6/docs/ref/#search.openSearchPanel) at least
+once).
 */
@@ -1091,2 +1102,2 @@ const setSearchQuery = /*@__PURE__*/StateEffect.define();
 
-export { RegExpCursor, SearchCursor, SearchQuery, closeSearchPanel, findNext, findPrevious, getSearchQuery, gotoLine, highlightSelectionMatches, openSearchPanel, replaceAll, replaceNext, searchConfig, searchKeymap, selectMatches, selectNextOccurrence, selectSelectionMatches, setSearchQuery };
+export { RegExpCursor, SearchCursor, SearchQuery, closeSearchPanel, findNext, findPrevious, getSearchQuery, gotoLine, highlightSelectionMatches, openSearchPanel, replaceAll, replaceNext, search, searchConfig, searchKeymap, selectMatches, selectNextOccurrence, selectSelectionMatches, setSearchQuery };

package.json

 {
   "name": "@codemirror/search",
-  "version": "0.19.6",
+  "version": "0.19.7",
   "description": "Search functionality for the CodeMirror code editor",
@@ -5,0 +5,0 @@ "scripts": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

102104

increased by1.88%

Lines of code

2503

increased by1.21%

No dependency changes