algolia-uploader 0.0.14 → 0.0.15-beta.2
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/README.md +15 -0
- package/dist/index.mjs +39 -31
- package/package.json +22 -25
- package/dist/index.cjs +0 -32
- package/dist/index.d.cts +0 -1
- package/dist/index.d.mts +0 -1
- package/dist/index.d.ts +0 -1
package/README.md
CHANGED
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
This is a command-line util to upload Algolia sources. This idea comes from [atomic-algolia](https://github.com/chrisdmacrae/atomic-algolia).
|
|
4
4
|
|
|
5
|
+
> [!NOTE]
|
|
6
|
+
> This package is currently supported as a CLI-only tool. Programmatic import as a library API is out of scope.
|
|
7
|
+
|
|
5
8
|
## Install
|
|
6
9
|
|
|
7
10
|
```
|
|
@@ -109,6 +112,12 @@ or
|
|
|
109
112
|
|
|
110
113
|
A `devcontainer` is included.
|
|
111
114
|
|
|
115
|
+
> [!IMPORTANT]
|
|
116
|
+
> Build tooling uses `tsdown`, which requires Node.js 22.22.1 or higher to run the build.
|
|
117
|
+
> Runtime support is Node.js 22.22.1 or higher.
|
|
118
|
+
|
|
119
|
+
### Toolchain setup
|
|
120
|
+
|
|
112
121
|
In this repository, `.env` and `.env.ci` are encrypted with [dotenvx](https://dotenvx.com/docs/quickstart).
|
|
113
122
|
|
|
114
123
|
- `.env` is for debugging and testing in your local environment
|
|
@@ -131,6 +140,12 @@ The tests attempt to read the local `.env` file, but the actual variables used i
|
|
|
131
140
|
|
|
132
141
|
Therefore, the tests do not access your real Algolia application.
|
|
133
142
|
|
|
143
|
+
### How to lint and format
|
|
144
|
+
|
|
145
|
+
Run `npm run lint`.
|
|
146
|
+
|
|
147
|
+
This repository uses Biome for linting and formatting.
|
|
148
|
+
|
|
134
149
|
### GitHub Actions
|
|
135
150
|
|
|
136
151
|
Testing with GitHub Actions uses `.env.ci`.
|