@ember-template-lint/todo-utils - npm Package Compare versions

Comparing version 11.0.0-beta.1 to 11.0.0

CHANGELOG.md

 
 
+
+## v11.0.0 (2021-12-03)
+
+#### :memo: Documentation
+* [#304](https://github.com/ember-template-lint/ember-template-lint-todo-utils/pull/304) Fixing jsdoc for new APIs ([@scalvert](https://github.com/scalvert))
+
+#### Committers: 1
+- Steve Calvert ([@scalvert](https://github.com/scalvert))
+
+
 ## v11.0.0-beta.1 (2021-12-02)
@@ -4,0 +14,0 @@

lib/io.d.ts

@@ -67,2 +67,3 @@ import { FilePath, TodoData, TodoBatchCounts, TodoBatches, WriteTodoOptions, Operation, OperationOrConflictLine } from './types';
  * @param baseDir - The base directory that contains the .lint-todo storage directory.
+ * @param shouldLock - True if the .lint-todo storage file should be locked, otherwise false. Default: true.
  * @returns - A {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map|Map} of {@link https://github.com/ember-template-lint/ember-template-lint-todo-utils/blob/master/src/types/todo.ts#L25|FilePath}/{@link https://github.com/ember-template-lint/ember-template-lint-todo-utils/blob/master/src/todo-matcher.ts#L4|TodoMatcher}.
@@ -76,2 +77,3 @@ */
  * @param filePath - The relative file path of the file to return todo items for.
+ * @param shouldLock - True if the .lint-todo storage file should be locked, otherwise false. Default: true.
  * @returns - A {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map|Map} of {@link https://github.com/ember-template-lint/ember-template-lint-todo-utils/blob/master/src/types/todo.ts#L25|FilePath}/{@link https://github.com/ember-template-lint/ember-template-lint-todo-utils/blob/master/src/todo-matcher.ts#L4|TodoMatcher}.
@@ -102,3 +104,3 @@ */
  * @param remove - Batch of todos to remove.
- * @param options - An object containing write options.
+ * @param shouldLock - True if the .lint-todo storage file should be locked, otherwise false. Default: true.
  */
@@ -105,0 +107,0 @@ export declare function applyTodoChanges(baseDir: string, add: Set<TodoData>, remove: Set<TodoData>, shouldLock?: boolean): void;

lib/io.js

@@ -139,2 +139,3 @@ "use strict";
  * @param baseDir - The base directory that contains the .lint-todo storage directory.
+ * @param shouldLock - True if the .lint-todo storage file should be locked, otherwise false. Default: true.
  * @returns - A {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map|Map} of {@link https://github.com/ember-template-lint/ember-template-lint-todo-utils/blob/master/src/types/todo.ts#L25|FilePath}/{@link https://github.com/ember-template-lint/ember-template-lint-todo-utils/blob/master/src/todo-matcher.ts#L4|TodoMatcher}.
@@ -161,2 +162,3 @@ */
  * @param filePath - The relative file path of the file to return todo items for.
+ * @param shouldLock - True if the .lint-todo storage file should be locked, otherwise false. Default: true.
  * @returns - A {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map|Map} of {@link https://github.com/ember-template-lint/ember-template-lint-todo-utils/blob/master/src/types/todo.ts#L25|FilePath}/{@link https://github.com/ember-template-lint/ember-template-lint-todo-utils/blob/master/src/todo-matcher.ts#L4|TodoMatcher}.
@@ -201,3 +203,3 @@ */
  * @param remove - Batch of todos to remove.
- * @param options - An object containing write options.
+ * @param shouldLock - True if the .lint-todo storage file should be locked, otherwise false. Default: true.
  */
@@ -204,0 +206,0 @@ function applyTodoChanges(baseDir, add, remove, shouldLock = true) {

package.json

 {
   "name": "@ember-template-lint/todo-utils",
-  "version": "11.0.0-beta.1",
+  "version": "11.0.0",
   "repository": "https://github.com/ember-template-lint/ember-template-lint-todo-utils.git",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -50,6 +50,6 @@ # @ember-template-lint/todo-utils
 </dd>
-<dt><a href="#readTodos">readTodos(baseDir)</a> ⇒</dt>
+<dt><a href="#readTodos">readTodos(baseDir, shouldLock)</a> ⇒</dt>
 <dd><p>Reads all todo files in the .lint-todo directory.</p>
 </dd>
-<dt><a href="#readTodosForFilePath">readTodosForFilePath(todoStorageDir, filePath)</a> ⇒</dt>
+<dt><a href="#readTodosForFilePath">readTodosForFilePath(todoStorageDir, filePath, shouldLock)</a> ⇒</dt>
 <dd><p>Reads todo files in the .lint-todo directory for a specific filePath.</p>
@@ -63,3 +63,3 @@ </dd>
 </dd>
-<dt><a href="#applyTodoChanges">applyTodoChanges(baseDir, add, remove, options)</a></dt>
+<dt><a href="#applyTodoChanges">applyTodoChanges(baseDir, add, remove, shouldLock)</a></dt>
 <dd><p>Applies todo changes, either adding or removing, based on batches from <code>getTodoBatches</code>.</p>
@@ -73,3 +73,3 @@ </dd>
 </dd>
-<dt><a href="#compactTodoStorageFile">compactTodoStorageFile(baseDir, compactStrategy)</a></dt>
+<dt><a href="#compactTodoStorageFile">compactTodoStorageFile(baseDir, compactStrategy)</a> ⇒</dt>
 <dd><p>Compacts the .lint-todo storage file based on the compact strategy.</p>
@@ -220,3 +220,3 @@ </dd>
 
-## readTodos(baseDir) ⇒
+## readTodos(baseDir, shouldLock) ⇒
 Reads all todo files in the .lint-todo directory.
@@ -227,9 +227,10 @@
 
-| Param | Description |
-| --- | --- |
-| baseDir | The base directory that contains the .lint-todo storage directory. |
+| Param | Default | Description |
+| --- | --- | --- |
+| baseDir |  | The base directory that contains the .lint-todo storage directory. |
+| shouldLock | <code>true</code> | True if the .lint-todo storage file should be locked, otherwise false. Default: true. |
 
 <a name="readTodosForFilePath"></a>
 
-## readTodosForFilePath(todoStorageDir, filePath) ⇒
+## readTodosForFilePath(todoStorageDir, filePath, shouldLock) ⇒
 Reads todo files in the .lint-todo directory for a specific filePath.
@@ -244,2 +245,3 @@
 | filePath | The relative file path of the file to return todo items for. |
+| shouldLock | True if the .lint-todo storage file should be locked, otherwise false. Default: true. |
 
@@ -274,3 +276,3 @@ <a name="readTodoData"></a>
 
-## applyTodoChanges(baseDir, add, remove, options)
+## applyTodoChanges(baseDir, add, remove, shouldLock)
 Applies todo changes, either adding or removing, based on batches from `getTodoBatches`.
@@ -280,8 +282,8 @@
 
-| Param | Description |
-| --- | --- |
-| baseDir | The base directory that contains the .lint-todo storage directory. |
-| add | Batch of todos to add. |
-| remove | Batch of todos to remove. |
-| options | An object containing write options. |
+| Param | Default | Description |
+| --- | --- | --- |
+| baseDir |  | The base directory that contains the .lint-todo storage directory. |
+| add |  | Batch of todos to add. |
+| remove |  | Batch of todos to remove. |
+| shouldLock | <code>true</code> | True if the .lint-todo storage file should be locked, otherwise false. Default: true. |
 
@@ -314,6 +316,7 @@ <a name="ADD_OPERATIONS_ONLY"></a>
 
-## compactTodoStorageFile(baseDir, compactStrategy)
+## compactTodoStorageFile(baseDir, compactStrategy) ⇒
 Compacts the .lint-todo storage file based on the compact strategy.
 
 **Kind**: global function  
+**Returns**: The count of compacted todos.  
 
@@ -320,0 +323,0 @@ | Param | Description |

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

124433

increased by1.04%

Lines of code

1341

increased by0.3%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

451

increased by0.67%

No dependency changes