feat(processor-utils): Add index to ClassNameSlugVars (#63)

* feat(processor-utils): Add `index` to ClassNameSlugVars * update docs --------- Co-authored-by: Neo Nie <gongwu.nie@revolut.com>
Anber · Mar 1, 2024 · aa1ca75 · aa1ca75
1 parent 9d7cb05
commit aa1ca75
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 1 deletion.
diff --git a/.changeset/few-dolphins-unite.md b/.changeset/few-dolphins-unite.md
@@ -0,0 +1,6 @@
+---
+'@wyw-in-js/processor-utils': minor
+'@wyw-in-js/shared': minor
+---
+
+Add `index` to ClassNameSlugVars
diff --git a/apps/website/pages/configuration.mdx b/apps/website/pages/configuration.mdx
@@ -137,7 +137,7 @@ module.exports = {
 
   Would generate the class name `.absdjfsdf__42__header`.
 
-  Last argument `args` is an object that contains following properties: `title`, `hash`, `dir`, `ext`, `file`, `name`. These properties
+  Last argument `args` is an object that contains following properties: `title`, `hash`, `index`, `dir`, `ext`, `file`, `name`. These properties
   are useful when you want to generate your own hash:
 
   ```js

diff --git a/packages/processor-utils/src/utils/getClassNameAndSlug.ts b/packages/processor-utils/src/utils/getClassNameAndSlug.ts
@@ -33,6 +33,7 @@ export default function getClassNameAndSlug(
   const slugVars: ClassNameSlugVars = {
     hash: slug,
     title: displayName,
+    index: idx,
     file: relativeFilename,
     ext,
     name: basename(relativeFilename, ext),

diff --git a/packages/shared/src/options/types.ts b/packages/shared/src/options/types.ts
@@ -12,6 +12,7 @@ export type ClassNameSlugVars = {
   ext: string;
   file: string;
   hash: string;
+  index: number;
   name: string;
   title: string;
 };