feat(core): leaveOnlyLastestPerEnv -> keepOnlyLatest

BREAKING CHANGE: Rename `LocalFileStore.recordRemoval.leaveOnlyLastestPerEnv` to `LocalFileStore.recordRemoval.keepOnlyLatest`

.changeset/core-store-keepOnlyLatest.md

@@ -0,0 +1,5 @@
+---
+'@haetae/core': patch
+---
+
+BREAKING CHANGE: Rename `LocalFileStore.recordRemoval.leaveOnlyLastestPerEnv` to `LocalFileStore.recordRemoval.keepOnlyLatest`

packages/core/src/index.ts

@@ -564,7 +564,7 @@ export interface LocalFileStoreOptions {
     age?: number | string
     count?: number
     // countPerEnv?: number // TODO: Implement this
-    leaveOnlyLastestPerEnv?: boolean
+    keepOnlyLatest?: boolean
   }
 }
 
@@ -574,7 +574,7 @@ export function localFileStore({
     age = Number.POSITIVE_INFINITY,
     // countPerEnv = Number.POSITIVE_INFINITY, // TODO: Implement this
     count = Number.POSITIVE_INFINITY,
-    leaveOnlyLastestPerEnv = true,
+    keepOnlyLatest = true,
   } = {},
   filename = '.haetae/store.json',
 }: LocalFileStoreOptions = {}): LocalFileStoreConnector {
@@ -627,7 +627,7 @@ export function localFileStore({
         draft.specVersion = localFileStoreSpecVersion
         draft.commands = draft.commands || {}
         draft.commands[command] = draft.commands[command] || []
-        if (leaveOnlyLastestPerEnv) {
+        if (keepOnlyLatest) {
           draft.commands[command] = draft.commands[command].filter(
             // remove old record with same env. So there's only one record left for each env.
             (oldRecord) => record.envHash !== oldRecord.envHash,
@@ -639,7 +639,7 @@ export function localFileStore({
         // @ts-ignore
         draft.commands[command] = draft.commands[command]
           .filter(
-            (r) => !leaveOnlyLastestPerEnv || r.envHash !== record.envHash,
+            (r) => !keepOnlyLatest || r.envHash !== record.envHash,
           )
           .filter(
             (r) => Date.now() - r.time < this.localFileStore.recordRemoval.age,

packages/docs/pages/apis/core.mdx

@@ -795,7 +795,7 @@ interface LocalFileStoreOptions {
   recordRemoval?: {
     age?: number | string
     count?: number
-    leaveOnlyLastestPerEnv?: boolean
+    keepOnlyLatest?: boolean
   }
 }
 ```
@@ -824,7 +824,7 @@ Records whose age is older than this value are to be removed when calling [`addR
 When the number of records becomes larger than this value, old records are removed to satisfy the threshold
 when calling [`addRecord`](#addrecord). This task is executed after `recordRemoval.age{:ts}` is used.
 <small>(default: `Number.POSITIVE_INFINITY{:ts}`) </small>
-- `recordRemoval.leaveOnlyLastestPerEnv?{:ts}` : If `true{:ts}`, only the lastet records per `env` exist in the store file.
+- `recordRemoval.keepOnlyLatest?{:ts}` : If `true{:ts}`, only the latest records per `env` exist in the store file.
 This is useful if you only depend on the latest record per `env`.
 <small>(default: `true{:ts}`) </small>
 

packages/docs/pages/getting-started.mdx

@@ -984,14 +984,14 @@ The practical guide with [`utils.hash(){:ts}`](./apis/utils#hash) is explained j
 </Callout>
 
 <Callout>
-**`recordRemoval.leaveOnlyLastestPerEnv` of [`localFileStore`](./apis/core#localfilestore)** <br/>
+**`recordRemoval.keepOnlyLatest` of [`LocalFileStore`](./apis/core#localfilestore)** <br/>
 By default, you're using [`localFileStore`](./apis/core#localfilestore) as a *'Store Connector'*.
-[`localFileStore`](./apis/core#localfilestore) stores records into a file (*`.haetae/store.json`*).
-The option `recordRemoval.leaveOnlyLastestPerEnv{:ts}` is `true{:ts}` by default.
-So only the last records per `env` exist in the store file.
-This is useful when you only depend on the latest *Records*.
+[`localFileStore`](./apis/core#localfilestore) stores records into the local file *`.haetae/store.json`*.
+The option `recordRemoval.keepOnlyLatest{:ts}` is `true{:ts}` by default.
+So only the single lastest *Record*s per *Env* per *Command* exist in the store file.
+This is sensible when you only need the latest *Record*.
 To utilize further past *Records*, you can set the option `false{:ts}`.
-Changing or configuring *'Store Connector'* is guided later.
+Changing or configuring *'Store Connector'* is guided from the [Custom Store](#custom-store) section.
 </Callout>
 
 5 Records are found in total.
@@ -1606,7 +1606,7 @@ export default configure({
     // You can pass custom `LocalFileStoreOptions`
     filename: '.haetae/store.json'
     recordRemoval: {
-      leaveOnlyLastestPerEnv: true,
+      keepOnlyLatest: true,
       // and more ...
     }
   ),