-# `surimi` - Safe SASS validation library
+# `scss-validate` - Safe SASS validation library
-Make your SCSS/SASS safer with `surimi`. Define a schema for your data and ensure users use it correctly!
+Make your SCSS/SASS safer with `scss-validate`. Define a schema for your data and ensure users use it correctly!
- 🔒 Bulletproof error-checking makes sure you (or your users) don't miss a thing!
- 🚀 No runtime! It's all just SCSS. You'll see the error before it's too late
@@ -26,30 +26,30 @@ Make your SCSS/SASS safer with `surimi`. Define a schema for your data and ensur
- ✅ Tested with [Vitest](https://vitest.dev) and the sass compiler
> [!NOTE]
-> Documentation and reference are now available on our website, [surimi.dev](https://surimi.dev).
-> For a quick intro into surimi, check out [surimi.dev/intro](https://surimi.dev/intro)
+> Documentation and reference are now available on our website, [scss-validate.dev](https://scss-validate.dev).
+> For a quick intro into scss-validate, check out [scss-validate.dev/intro](https://scss-validate.dev/intro)
## installation
-Surimi is available as an npm package
+scss-validate is available as an npm package
```bash
# npm
-npm install surimi
+npm install scss-validate
# pnpm
-pnpm add surimi
+pnpm add scss-validate
```
or via a CDN like unpkg. To load it from a CDN, just `@use` it in your Sass file:
```scss
-@use 'https://unpkg.com/surimi@latest' as s;
+@use 'https://unpkg.com/scss-validate@latest' as s;
```
## introduction
```scss
-@use 'surimi' as s;
+@use 'scss-validate' as s;
$my-number-schema: s.number(
$gte: 18,
@@ -68,13 +68,13 @@ $my-string-schema: s.string(
You will recognize many of the properties - they are simple strings similar to 'zod' or 'yup'. And if you do put a wrong one.. We got you covered!
```
-[surimi] `string.min` is not a valid validator. Allowed validators are: [eq, in, not-in, contains, not-contains, ... max-length, min-length]
+[scss-validate] `string.min` is not a valid validator. Allowed validators are: [eq, in, not-in, contains, not-contains, ... max-length, min-length]
```
-All `surimi` methods are validated themselves - leaving zero room for errors. Of course, validation errors look just as nice:
+All `scss-validate` methods are validated themselves - leaving zero room for errors. Of course, validation errors look just as nice:
```
-[surimi] Value must be greater than or equal to 18
+[scss-validate] Value must be greater than or equal to 18
```
-For a full introduction, visit our [docs](https://surimi.dev/intro), or check out the [reference](https://surimi.dev/reference)
+For a full introduction, visit our [docs](https://scss-validate.dev/intro), or check out the [reference](https://scss-validate.dev/reference)
diff --git a/package.json b/package.json
index c5bc502..9f7bfe8 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@janis.me/sass",
- "description": "surimi - Safe SASS validation library",
+ "description": "scss-validate - Safe SASS validation library",
"keywords": [
"janis.me",
"sass",
@@ -10,7 +10,7 @@
"homepage": "https://janis.me",
"repository": {
"type": "git",
- "url": "git+https://github.com/janis-me/surimi.git"
+ "url": "git+https://github.com/janis-me/scss-validate.git"
},
"license": "MIT",
"author": "Janis Jansen",
@@ -34,7 +34,7 @@
"typescript": "catalog:build",
"vitest": "catalog:test"
},
- "packageManager": "pnpm@10.11.0",
+ "packageManager": "pnpm@10.17.1",
"engines": {
"node": ">=22.11.0"
}
diff --git a/packages/docs/astro.config.mjs b/packages/docs/astro.config.mjs
index 5de05e8..4aed7e1 100644
--- a/packages/docs/astro.config.mjs
+++ b/packages/docs/astro.config.mjs
@@ -7,7 +7,7 @@ import remarkToc from 'remark-toc';
// https://astro.build/config
export default defineConfig({
- site: 'https://surimi.dev',
+ site: 'https://scss-validate.dev',
integrations: [
mdx({
rehypePlugins: [
diff --git a/packages/docs/public/surimi-1024x1024.webp b/packages/docs/public/surimi-1024x1024.webp
deleted file mode 100644
index 922ba70..0000000
Binary files a/packages/docs/public/surimi-1024x1024.webp and /dev/null differ
diff --git a/packages/docs/public/surimi-128x128.webp b/packages/docs/public/surimi-128x128.webp
deleted file mode 100644
index b8104b3..0000000
Binary files a/packages/docs/public/surimi-128x128.webp and /dev/null differ
diff --git a/packages/docs/public/surimi-256x256.webp b/packages/docs/public/surimi-256x256.webp
deleted file mode 100644
index 55d25ee..0000000
Binary files a/packages/docs/public/surimi-256x256.webp and /dev/null differ
diff --git a/packages/docs/public/surimi-512x512.webp b/packages/docs/public/surimi-512x512.webp
deleted file mode 100644
index 20c6fcd..0000000
Binary files a/packages/docs/public/surimi-512x512.webp and /dev/null differ
diff --git a/packages/docs/public/surimi.png b/packages/docs/public/surimi.png
deleted file mode 100644
index e8c0cd4..0000000
Binary files a/packages/docs/public/surimi.png and /dev/null differ
diff --git a/packages/docs/src/layouts/Layout.astro b/packages/docs/src/layouts/Layout.astro
index 1e3d01a..c78fcca 100644
--- a/packages/docs/src/layouts/Layout.astro
+++ b/packages/docs/src/layouts/Layout.astro
@@ -1,13 +1,6 @@
----
-import { Image } from 'astro:assets';
-
-import logo from '../assets/surimi-256x256.webp';
----
-
-
+
+ 
+ 
+ 