Skip to content

Commit

Permalink
Merge pull request #1179 from pjkaufman/master
Browse files Browse the repository at this point in the history
Auto-release beta 1.27.0-rc-1
  • Loading branch information
pjkaufman authored Sep 28, 2024
2 parents 21856fc + 62d8e45 commit 018fc69
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 6 deletions.
24 changes: 21 additions & 3 deletions docs/docs/settings/content-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Uses a dictionary of common misspellings to automatically convert them to their
| Name | Description | List Items | Default Value |
| ---- | ----------- | ---------- | ------------- |
| `Ignore Words` | A comma separated list of lowercased words to ignore when auto-correcting | N/A | |
| `Skip Words with Multiple Capitals` | Will skip any files that have a capital letter in them other than as the first letter of the word. Acronyms and some other words can benefit from this. It may cause issues with proper nouns being properly fixed. | N/A | false |
| `Extra Auto-Correct Source Files` | These are files that have a markdown table in them that have the initial word and the word to correct it to (these are case insensitive corrections). **Note: the tables used should have the starting and ending `|` indicators present for each line.** | N/A | |

### Additional Info
Expand Down Expand Up @@ -47,9 +48,8 @@ The following is a table with custom misspellings:

##### Current Limitations


- The list of custom replacements is only loaded when the plugin first lints a file or when the file is added to the list of files that include custom misspellings
* This means that making a change to a file that is already in the list of custom misspelling files will not work unless the Linter is reloaded or the file is removed and re-added to the list of custom misspelling files
- The list of custom replacements is only loaded automatically when the plugin first lints a file or when the file is added to the list of files that include custom misspellings
- There is an option to manually rerun the parse custom misspelling files from the Auto-Correct Common Misspellings settings
- There is no way to specify that a word is to always be capitalized
- This is due to how the auto-correct rule was designed as it sets the first letter of the replacement word to the case of the first letter of the word being replaced

Expand Down Expand Up @@ -134,6 +134,24 @@ After:
http://www.Absoltely.com should not be corrected
``````
</details>
<details><summary>Auto-correct misspellings skips words with multiple capital letters in them if `Skip Words with Multiple Capitals` is Enabled</summary>

Before:

`````` markdown
HSA here will not be auto-corrected to Has since it has more than one capital letter.
aADD will not be converted to add.
But this also affects javaSrript(what should be JavaScript) and other proper names as well which will not be auto-corrected.
``````

After:

`````` markdown
HSA here will not be auto-corrected to Has since it has more than one capital letter.
aADD will not be converted to add.
But this also affects javaSrript(what should be JavaScript) and other proper names as well which will not be auto-corrected.
``````
</details>

## Blockquote Style

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/settings/yaml-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -1079,9 +1079,10 @@ Keep track of the date the file was last edited in the YAML front matter. Gets d
| ---- | ----------- | ---------- | ------------- |
| `Date Created` | Insert the file creation date | N/A | `true` |
| `Date Created Key` | Which YAML key to use for creation date | N/A | `date created` |
| `Force Date Created Key Value Retention` | Reuses the value in the YAML frontmatter for date created instead of the file metadata which is useful for preventing file metadata changes from causing the value to change to a different value. | N/A | false |
| `Date Created Source of Truth` | Specifies where to get the date created value from if it is already present in the frontmatter. | `file system`: The file system date created value is used to set the value of date created in the frontmatter<br/><br/>`frontmatter`: When a value is present in the frontmatter for date created, this value is used as the value for the date created | `file system` |
| `Date Modified` | Insert the date the file was last modified | N/A | `true` |
| `Date Modified Key` | Which YAML key to use for modification date | N/A | `date modified` |
| `Date Modified Source of Truth` | Specifies what way should be used to determine when the date modified should be updated if it is already present in the frontmatter. | `file system`: The file system date modified value is used to set the value of date modified in the frontmatter<br/><br/>`user or Linter edits`: When a value is present in the frontmatter for date modified, date modified is kept as is unless the user or the Linter makes a change to the file | `file system` |
| `Format` | Moment date format to use (see [Moment format options](https://momentjscom.readthedocs.io/en/latest/moment/04-displaying/01-format/)) | N/A | `dddd, MMMM Do YYYY, h:mm:ss a` |
| `Convert Local Time to UTC` | Uses UTC equivalent for saved dates instead of local time | N/A | false |

Expand Down
2 changes: 1 addition & 1 deletion manifest-beta.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "obsidian-linter",
"name": "Linter",
"version": "1.26.0",
"version": "1.27.0-rc-1",
"minAppVersion": "1.5.7",
"description": "Formats and styles your notes. It can be used to format YAML tags, aliases, arrays, and metadata; footnotes; headings; spacing; math blocks; regular markdown contents like list, italics, and bold styles; and more with the use of custom rule options as well.",
"author": "Victor Tao",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "obsidian-linter",
"version": "1.26.0",
"version": "1.27.0-rc-1",
"description": "Enforces consistent markdown styling for Obsidian (https://obsidian.md). It can be used to format YAML tags, aliases, arrays, and metadata; footnotes; headings; spacing; math blocks; regular markdown contents like list, italics, and bold styles; and more with the use of custom rule options as well.",
"main": "main.js",
"scripts": {
Expand Down

0 comments on commit 018fc69

Please sign in to comment.