@salty-css/eslint-plugin-core 0.0.1-alpha.12 → 0.0.1-alpha.121

package/README.md

@@ -1,15 +1,91 @@
-# Salty Css
+# Salty CSS - Kinda sweet but yet spicy CSS-in-JS library
 
-## Basic usage example with Button
+In the world of frontend dev is there anything saltier than CSS? Salty CSS is built to provide better developer experience for developers looking for performant and feature rich CSS-in-JS solutions.
 
-### Initial requirements
+## Features
 
-1. Add `saltyPlugin` to vite or webpack config from `@salty-css/vite` or `@salty-css/webpack`
-2. Create `salty-config.ts` to the root of your project
-3. Import global styles to any regular .css file from `saltygen/index.css` (does not exist during first run, cli command coming later)
-4. Create salty components with styled only inside files that end with `.css.ts`, `.salty.ts` `.styled.ts` or `.styles.ts`
+- Build time compilation to achieve awesome runtime performance and minimal size
+- Next.js, React Server Components, Vite and Webpack support
+- Type safety with out of the box TypeScript and ESLint plugin
+- Advanced CSS variables configuration to allow smooth token usage
+- Style templates to create reusable styles easily
 
-### Code examples
+## Get started
+
+- Initialize: `npx salty-css init [directory]`
+- Create component: `npx salty-css generate [filePath]`
+- Build: `npx salty-css build [directory]`
+
+### Initialize
+
+Fastest way to get started with any framework is [npx salty-css init [directory]](#initialize-salty-css-for-a-project) command
+
+- Next.js → [Next.js guide](#nextjs) + [Next.js example app](https://github.com/margarita-form/salty-css-website)
+- React → [React guide](#react) + [React example code](#code-examples)
+- Vite → [Vite guide](#vite)
+- Webpack → Guide coming soon
+- ESLint → Guide coming soon
+
+### Salty CSS CLI
+
+In your existing repository you can use `npx salty-css [command]` to initialize a project, generate components, update related packages and build required files.
+
+- Initialize project → `npx salty-css init [directory]` - Installs required packages, detects framework in use and creates project files to the provided directory. Directory can be left blank if you want files to be created to the current directory.
+- Generate component → `npx salty-css update [version]` - Update @salty-css packages in your repository. Default version is "latest". Additional options like `--dir`, `--tag`, `--name` and `--className` are also supported.
+- Build files → `npx salty-css build [directory]` - Compile Salty CSS related files in your project. This should not be needed if you are using tools like Next.js or Vite
+
+### Guides
+
+#### Next.js
+
+In your existing Next.js repository you can run `npx salty-css init` to automatically configure Salty CSS.
+
+##### Manual configuration
+
+1. For Next.js support install `npm i @salty-css/next @salty-css/core @salty-css/react`
+2. Create `salty.config.ts` to your app directory
+3. Add Salty CSS plugin to next.js config
+
+- **Next.js 15:** In `next.config.ts` add import for salty plugin `import { withSaltyCss } from '@salty-css/next';` and then add `withSaltyCss` to wrap your nextConfig export like so `export default withSaltyCss(nextConfig);`
+- **Next.js 14 and older:** In `next.config.js` add import for salty plugin `const { withSaltyCss } = require('@salty-css/next');` and then add `withSaltyCss` to wrap your nextConfig export like so `module.exports = withSaltyCss(nextConfig);`
+
+4. Make sure that `salty.config.ts` and `next.config.ts` are in the same folder!
+5. Build `saltygen` directory by running your app once or with cli `npx salty-css build [directory]`
+6. Import global styles from `saltygen/index.css` to some global css file with `@import 'insert_path_to_index_css';`.
+
+[Check out Next.js demo project](https://github.com/margarita-form/salty-css-website) or [react example code](#code-examples)
+
+#### Vite
+
+In your existing Vite repository you can run `npx salty-css init` to automatically configure Salty CSS.
+
+##### Manual configuration
+
+1. For Vite support install `npm i @salty-css/vite @salty-css/core`
+2. In `vite.config` add import for salty plugin `import { saltyPlugin } from '@salty-css/vite';` and then add `saltyPlugin(__dirname)` to your vite configuration plugins
+3. Make sure that `salty.config.ts` and `vite.config.ts` are in the same folder!
+4. Build `saltygen` directory by running your app once or with cli `npx salty-css build [directory]`
+5. Import global styles from `saltygen/index.css` to some global css file with `@import 'insert_path_to_index_css';`.
+
+#### React
+
+In your existing React repository you can run `npx salty-css init` to automatically configure Salty CSS.
+
+##### Manual configuration
+
+1. Install related dependencies: `npm i @salty-css/core @salty-css/react`
+2. Create `salty.config.ts` to your app directory
+3. Configure your build tool to support Salty CSS ([Vite](#vite) or Webpack) or after changes run `npx salty-css build`
+
+[Check out react example code](#code-examples)
+
+### Create components
+
+1. Create salty components with styled only inside files that end with `.css.ts`, `.salty.ts` `.styled.ts` or `.styles.ts`
+
+## Code examples
+
+### Basic usage example with Button
 
 **Salty config**
 
@@ -31,23 +107,6 @@ export const config = defineConfig({
 });
 ```
 
-**Your React component file**
-
-```tsx
-import { Wrapper } from '../components/wrapper/wrapper.css';
-import { Button } from '../components/button/button.css';
-
-export const IndexPage = () => {
-  return (
-    <Wrapper>
-      <Button variant="solid" onClick={() => alert('It is a button.')}>
-        Outlined
-      </Button>
-    </Wrapper>
-  );
-};
-```
-
 **Wrapper** (`components/wrapper/wrapper.css.ts`)
 
 ```tsx
@@ -72,7 +131,7 @@ export const Button = styled('button', {
     padding: `0.6em 1.2em`,
     border: '1px solid currentColor',
     background: 'transparent',
-    color: 'currentColor/40',
+    color: 'currentColor',
     cursor: 'pointer',
     transition: '200ms',
     textDecoration: 'none',
@@ -108,4 +167,21 @@ export const Button = styled('button', {
 });
 ```
 
+**Your React component file**
+
+```tsx
+import { Wrapper } from '../components/wrapper/wrapper.css';
+import { Button } from '../components/button/button.css';
+
+export const IndexPage = () => {
+  return (
+    <Wrapper>
+      <Button variant="solid" onClick={() => alert('It is a button.')}>
+        Outlined
+      </Button>
+    </Wrapper>
+  );
+};
+```
+
 More examples coming soon

package/index.cjs

@@ -1 +1 @@
-"use strict";require("esbuild");const d=require("winston");require("child_process");require("path");require("fs");require("fs/promises");function y(e){const r=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(e){for(const n in e)if(n!=="default"){const t=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(r,n,t.get?t:{enumerable:!0,get:()=>e[n]})}}return r.default=e,Object.freeze(r)}const a=y(d);a.createLogger({level:"info",format:a.format.combine(a.format.colorize(),a.format.cli()),transports:[new a.transports.Console({})]});const f=["salty","css","styles","styled"],m=(e=[])=>new RegExp(`\\.(${[...f,...e].join("|")})\\.`),p=(e,r=[])=>m(r).test(e),b={meta:{type:"problem",docs:{description:"Ensure `variants` are not nested inside `base` in styled calls",category:"Errors",recommended:!0},messages:{nestedVariants:"`variants` should not be nested inside `base`."}},create(e){return p(e.filename)?{CallExpression:n=>{try{const{callee:t,arguments:u}=n;if(!(t.type==="Identifier"&&t.name==="styled"))return;const i=u[0];if(!i||!(i.type==="ObjectExpression"))return;const o=i.properties.find(s=>s.type==="Property"&&s.key.type==="Identifier"&&s.key.name==="base");if(!o)return;const{value:l}=o;if(!(l.type==="ObjectExpression"))return;const c=l.properties.find(s=>s.type==="Property"&&s.key.type==="Identifier"&&s.key.name==="variants");if(!c)return;e.report({node:c,messageId:"nestedVariants"})}catch(t){console.log("ESlint error",t);return}}}:{}}},g={rules:{"no-variants-in-base":b}};module.exports=g;
+"use strict";require("esbuild");require("child_process");require("path");require("fs");require("fs/promises");const o=require("winston");o.createLogger({level:"debug",format:o.format.combine(o.format.colorize(),o.format.cli()),transports:[new o.transports.Console({})]});const h=["salty","css","styles","styled"],P=(r=[])=>new RegExp(`\\.(${[...h,...r].join("|")})\\.`),x=(r,l=[])=>P(l).test(r),S={meta:{type:"problem",fixable:"code",docs:{description:"Ensure `variants` are not nested inside `base` in styled calls",category:"Errors",recommended:!0},messages:{nestedVariants:"`variants` should not be nested inside `base`."}},create(r){return x(r.filename)?{CallExpression:c=>{try{const{callee:i,arguments:e}=c;if(!(i.type==="Identifier"&&i.name==="styled"))return;const t=e[1];if(!t||!(t.type==="ObjectExpression"))return;const u=t.properties.find(s=>s.type==="Property"&&s.key.type==="Identifier"&&s.key.name==="base");if(!u)return;const{value:f}=u;if(!(f.type==="ObjectExpression"))return;const n=f.properties.find(s=>s.type==="Property"&&s.key.type==="Identifier"&&s.key.name==="variants");if(!n)return;r.report({node:n,messageId:"nestedVariants",fix:s=>{if(!n.range)return null;const{sourceCode:y}=r,b=y.getText(n),E=t.properties.indexOf(u),p=t.properties[E];if(!p.range)return null;const v=[p.range[1],p.range[1]],m=[n.range[0]-1,n.range[1]];if(f.properties.at(-1)===n){const g=y.text.slice(n.range[1]).match(/^\s*,/);g&&(m[1]+=g[0].length)}return[s.removeRange(m),s.insertTextAfterRange(v,`, ${b}`)]}})}catch(i){console.log("ESlint error",i);return}}}:{}}},I={meta:{type:"problem",fixable:"code",docs:{description:"Salty CSS related function calls or other values must be exported",category:"Errors",recommended:!0},messages:{mustBeExported:"Salty CSS related function calls or other values must be exported"}},create(r){if(!x(r.filename))return{};function c(e){if(e.type==="VariableDeclaration"){const a=e.declarations[0];if(a.type!=="VariableDeclarator")return;const t=a.init;if((t==null?void 0:t.type)!=="CallExpression")return;const d=["styled","keyframes"];if(t.callee.type==="Identifier"&&d.includes(t.callee.name))return!0}return!1}function i(e){const a=e.parent;return a.type==="ExportNamedDeclaration"||a.type==="ExportDefaultDeclaration"}return{VariableDeclaration:e=>{c(e)&&(i(e)||r.report({node:e,messageId:"mustBeExported",fix:a=>a.insertTextBefore(e,"export ")}))}}}},V={rules:{"no-variants-in-base":S,"must-be-exported":I}};module.exports=V;

package/index.d.ts

@@ -1,6 +1,7 @@
-declare const _default: {
+declare const eslintPluginCore: {
     rules: {
         'no-variants-in-base': import("eslint").Rule.RuleModule;
+        'must-be-exported': import("eslint").Rule.RuleModule;
     };
 };
-export default _default;
+export default eslintPluginCore;

package/index.js

@@ -1,17 +1,18 @@
 import "esbuild";
-import * as s from "winston";
 import "child_process";
 import "path";
 import "fs";
 import "fs/promises";
-s.createLogger({
-  level: "info",
-  format: s.format.combine(s.format.colorize(), s.format.cli()),
-  transports: [new s.transports.Console({})]
+import { createLogger as h, format as f, transports as P } from "winston";
+h({
+  level: "debug",
+  format: f.combine(f.colorize(), f.cli()),
+  transports: [new P.Console({})]
 });
-const d = ["salty", "css", "styles", "styled"], m = (t = []) => new RegExp(`\\.(${[...d, ...t].join("|")})\\.`), p = (t, a = []) => m(a).test(t), f = {
+const S = ["salty", "css", "styles", "styled"], I = (r = []) => new RegExp(`\\.(${[...S, ...r].join("|")})\\.`), x = (r, i = []) => I(i).test(r), V = {
   meta: {
     type: "problem",
+    fixable: "code",
     docs: {
       description: "Ensure `variants` are not nested inside `base` in styled calls",
       category: "Errors",
@@ -21,38 +22,95 @@ const d = ["salty", "css", "styles", "styled"], m = (t = []) => new RegExp(`\\.(
       nestedVariants: "`variants` should not be nested inside `base`."
     }
   },
-  create(t) {
-    return p(t.filename) ? {
-      CallExpression: (c) => {
+  create(r) {
+    return x(r.filename) ? {
+      CallExpression: (l) => {
         try {
-          const { callee: r, arguments: y } = c;
-          if (!(r.type === "Identifier" && r.name === "styled")) return;
-          const n = y[0];
-          if (!n || !(n.type === "ObjectExpression")) return;
-          const i = n.properties.find((e) => e.type === "Property" && e.key.type === "Identifier" && e.key.name === "base");
-          if (!i) return;
-          const { value: o } = i;
-          if (!(o.type === "ObjectExpression")) return;
-          const l = o.properties.find(
-            (e) => e.type === "Property" && e.key.type === "Identifier" && e.key.name === "variants"
+          const { callee: o, arguments: e } = l;
+          if (!(o.type === "Identifier" && o.name === "styled")) return;
+          const t = e[1];
+          if (!t || !(t.type === "ObjectExpression")) return;
+          const c = t.properties.find((s) => s.type === "Property" && s.key.type === "Identifier" && s.key.name === "base");
+          if (!c) return;
+          const { value: p } = c;
+          if (!(p.type === "ObjectExpression")) return;
+          const n = p.properties.find(
+            (s) => s.type === "Property" && s.key.type === "Identifier" && s.key.name === "variants"
           );
-          if (!l) return;
-          t.report({
-            node: l,
-            messageId: "nestedVariants"
+          if (!n) return;
+          r.report({
+            node: n,
+            messageId: "nestedVariants",
+            fix: (s) => {
+              if (!n.range) return null;
+              const { sourceCode: m } = r, b = m.getText(n), E = t.properties.indexOf(c), u = t.properties[E];
+              if (!u.range) return null;
+              const v = [u.range[1], u.range[1]], y = [
+                n.range[0] - 1,
+                // Include the preceding comma (if any)
+                n.range[1]
+              ];
+              if (p.properties.at(-1) === n) {
+                const g = m.text.slice(n.range[1]).match(/^\s*,/);
+                g && (y[1] += g[0].length);
+              }
+              return [s.removeRange(y), s.insertTextAfterRange(v, `, ${b}`)];
+            }
           });
-        } catch (r) {
-          console.log("ESlint error", r);
+        } catch (o) {
+          console.log("ESlint error", o);
           return;
         }
       }
     } : {};
   }
-}, I = {
+}, C = {
+  meta: {
+    type: "problem",
+    fixable: "code",
+    docs: {
+      description: "Salty CSS related function calls or other values must be exported",
+      category: "Errors",
+      recommended: !0
+    },
+    messages: {
+      mustBeExported: "Salty CSS related function calls or other values must be exported"
+    }
+  },
+  create(r) {
+    if (!x(r.filename)) return {};
+    function l(e) {
+      if (e.type === "VariableDeclaration") {
+        const a = e.declarations[0];
+        if (a.type !== "VariableDeclarator") return;
+        const t = a.init;
+        if ((t == null ? void 0 : t.type) !== "CallExpression") return;
+        const d = ["styled", "keyframes"];
+        if (t.callee.type === "Identifier" && d.includes(t.callee.name))
+          return !0;
+      }
+      return !1;
+    }
+    function o(e) {
+      const a = e.parent;
+      return a.type === "ExportNamedDeclaration" || a.type === "ExportDefaultDeclaration";
+    }
+    return {
+      VariableDeclaration: (e) => {
+        l(e) && (o(e) || r.report({
+          node: e,
+          messageId: "mustBeExported",
+          fix: (a) => a.insertTextBefore(e, "export ")
+        }));
+      }
+    };
+  }
+}, L = {
   rules: {
-    "no-variants-in-base": f
+    "no-variants-in-base": V,
+    "must-be-exported": C
   }
 };
 export {
-  I as default
+  L as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salty-css/eslint-plugin-core",
-  "version": "0.0.1-alpha.12",
+  "version": "0.0.1-alpha.121",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "typings": "./dist/index.d.ts",
@@ -10,7 +10,12 @@
   "publishConfig": {
     "access": "public"
   },
-  "homepage": "https://github.com/margarita-form/salty-css",
+  "description": "ESLint plugin for Salty CSS",
+  "homepage": "https://salty-css.dev/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/margarita-form/salty-css.git"
+  },
   "bugs": {
     "url": "https://github.com/margarita-form/salty-css/issues"
   },
@@ -28,8 +33,8 @@
       "require": "./index.cjs"
     }
   },
-  "peerDependencies": {
-    "@salty-css/core": ">=1.x || >=0.x",
-    "eslint": ">=9.x || >=8.x >=7.x"
+  "dependencies": {
+    "@salty-css/core": "^0.0.1-alpha.121",
+    "eslint": ">=9.x || >=8.x || >=7.x"
   }
 }

package/rules/must-be-exported.d.ts

@@ -0,0 +1,2 @@
+import { Rule } from 'eslint';
+export declare const mustBeExported: Rule.RuleModule;