@obsidian-typings/obsidian-public-latest 6.49.0 → 6.50.0
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.
- package/CHANGELOG.md +10 -0
- package/README.md +16 -2
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
|
+
## 6.50.0
|
|
4
|
+
|
|
5
|
+
- Now resolves to `@obsidian-typings/obsidian-public-1.14.4` `^1.13.0`. See [its release notes](https://github.com/obsidian-typings/obsidian-typings/releases/tag/obsidian-public-1.14.4-v1.13.0).
|
|
6
|
+
|
|
7
|
+
### Breaking changes in that release
|
|
8
|
+
|
|
9
|
+
- fix(read-view-renderer): add header, footer, sizerEl and the section API
|
|
10
|
+
- fix(file-explorer): type getSortedFolderItems as returning folder rows too
|
|
11
|
+
- fix(file-explorer): type a folder row's file as TFolder
|
|
12
|
+
|
|
3
13
|
## 6.49.0
|
|
4
14
|
|
|
5
15
|
- Now resolves to `@obsidian-typings/obsidian-public-1.14.4` `^1.12.0`. See [its release notes](https://github.com/obsidian-typings/obsidian-typings/releases/tag/obsidian-public-1.14.4-v1.12.0).
|
package/README.md
CHANGED
|
@@ -51,11 +51,25 @@ In most cases, we recommend to always use the latest release.
|
|
|
51
51
|
- Latest `catalyst` (`beta`) release:
|
|
52
52
|
- `npm install --save-dev @obsidian-typings/obsidian-catalyst-latest`
|
|
53
53
|
- Specific Obsidian version (should match `minAppVersion` in your plugin's `manifest.json`):
|
|
54
|
-
- `npm install --save-dev @obsidian-typings/obsidian-public-1.
|
|
55
|
-
- `npm install --save-dev @obsidian-typings/obsidian-catalyst-1.
|
|
54
|
+
- `npm install --save-dev @obsidian-typings/obsidian-public-1.13.7`
|
|
55
|
+
- `npm install --save-dev @obsidian-typings/obsidian-catalyst-1.13.7`
|
|
56
56
|
- Legacy package name (alias for `@obsidian-typings/obsidian-public-latest`):
|
|
57
57
|
- `npm install --save-dev obsidian-typings`
|
|
58
58
|
|
|
59
|
+
#### Depend on a specific Obsidian version under a stable name
|
|
60
|
+
|
|
61
|
+
Each Obsidian version has its own package, so not every Obsidian version has one. To find the packages that exist, look at the [`@obsidian-typings` org on npm](https://www.npmjs.com/org/obsidian-typings) or run `npm search @obsidian-typings`. For a `minAppVersion` of `1.13.0`, pick the oldest `1.13.x` package, which is `@obsidian-typings/obsidian-public-1.13.4`.
|
|
62
|
+
|
|
63
|
+
To avoid rewriting your imports and your `tsconfig.json` every time you move to another Obsidian version, install the package under an [npm alias](https://docs.npmjs.com/cli/commands/npm-install):
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
npm install --save-dev obsidian-typings@npm:@obsidian-typings/obsidian-public-1.13.4
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Your code then always refers to `obsidian-typings` (in `types`, in `import type {} from 'obsidian-typings'`, in `obsidian-typings/implementations` and in `declare module 'obsidian-typings'`). To move to another Obsidian version, run the same command with the new package name. Only the `package.json` entry changes.
|
|
70
|
+
|
|
71
|
+
The `-latest` packages can be pinned too: each version of `@obsidian-typings/obsidian-public-latest` depends on exactly one per-version package. `npm view @obsidian-typings/obsidian-public-latest@<version> dependencies` names it. Recent versions also name it in the package's `CHANGELOG.md`.
|
|
72
|
+
|
|
59
73
|
<!-- markdownlint-disable MD033 -->
|
|
60
74
|
|
|
61
75
|
### 2. Enable in `tsconfig.json` (recommended) <span id="add-types-setting-to-tsconfig-json"></span>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"dependencies": {
|
|
3
|
-
"@obsidian-typings/obsidian-public-1.14.4": "^1.
|
|
3
|
+
"@obsidian-typings/obsidian-public-1.14.4": "^1.13.0"
|
|
4
4
|
},
|
|
5
5
|
"description": "Latest obsidian-typings for Obsidian public releases.",
|
|
6
6
|
"exports": {
|
|
@@ -32,5 +32,5 @@
|
|
|
32
32
|
},
|
|
33
33
|
"type": "module",
|
|
34
34
|
"types": "./types.d.cts",
|
|
35
|
-
"version": "6.
|
|
35
|
+
"version": "6.50.0"
|
|
36
36
|
}
|