@pikacss/core 0.0.37 → 0.0.39

package/README.md

@@ -1 +1,201 @@
 # @pikacss/core
+
+The core Atomic CSS-in-JS engine of PikaCSS.
+
+## Installation
+
+```bash
+pnpm add @pikacss/core
+```
+
+## Quick Start
+
+**pika.config.ts**:
+```typescript
+import { defineEngineConfig } from '@pikacss/core'
+
+export default defineEngineConfig({
+  // Your configuration
+})
+```
+
+**Your code**:
+```typescript
+import { createEngine, defineEngineConfig } from '@pikacss/core'
+
+const config = defineEngineConfig({
+  // Engine configuration
+  prefix: 'pk-',
+  defaultSelector: '.%',
+  plugins: []
+})
+
+const engine = createEngine(config)
+await engine.setup()
+```
+
+## Features
+
+- ⚡ High-performance Atomic CSS-in-JS engine
+- 🎯 Type-safe with full TypeScript support
+- 🔌 Extensible plugin system
+- 🎨 Built-in support for shortcuts, selectors, variables, keyframes
+- 📦 Works at build-time, zero runtime overhead
+- 🔧 Fully configurable
+- 🌐 Framework-agnostic core
+
+## Usage for Integration Developers
+
+### Creating an Engine
+
+```typescript
+import { createEngine, defineEngineConfig } from '@pikacss/core'
+
+const config = defineEngineConfig({
+  // Prefix for generated atomic CSS class names
+  prefix: 'pk-',
+  
+  // Default selector format (% will be replaced with atomic ID)
+  defaultSelector: '.%',
+  
+  // Plugins to extend functionality
+  plugins: [],
+  
+  // Global CSS preflights
+  preflights: [],
+})
+
+const engine = createEngine(config)
+await engine.setup()
+```
+
+### Engine Methods
+
+The engine provides methods for managing CSS generation:
+
+```typescript
+// Add global CSS
+engine.addPreflight('* { box-sizing: border-box; }')
+
+// Access sub-systems
+engine.variables  // CSS variables management
+engine.keyframes  // CSS keyframes management
+engine.selectors  // CSS selectors management
+engine.shortcuts  // CSS shortcuts management
+engine.important  // Important rules management
+```
+
+### Configuration
+
+Use `defineEngineConfig` for type-safe configuration:
+
+```typescript
+import { defineEngineConfig } from '@pikacss/core'
+
+export default defineEngineConfig({
+  // Prefix for atomic class IDs
+  prefix: 'pk-',
+  
+  // Default selector format (% = atomic ID)
+  defaultSelector: '.%',
+  
+  // Global CSS preflights
+  preflights: [
+    ':root { --primary: #3b82f6; }',
+    // Or function:
+    ({ engine, isFormatted }) => '/* Generated CSS */'
+  ],
+  
+  // Shortcuts configuration
+  shortcuts: {
+    shortcuts: [
+      ['flex-center', {
+        display: 'flex',
+        alignItems: 'center',
+        justifyContent: 'center'
+      }],
+    ]
+  },
+  
+  // Plugins to extend functionality
+  plugins: []
+})
+```
+
+## API
+
+### Main Exports
+
+```typescript
+// Engine creation
+export function createEngine(config: EngineConfig): Engine
+
+// Type-safe config helpers
+export function defineEngineConfig(config: EngineConfig): EngineConfig
+export function defineEnginePlugin(plugin: EnginePlugin): EnginePlugin
+export function defineStyleDefinition(def: StyleDefinition): StyleDefinition
+export function definePreflight(preflight: Preflight): Preflight
+export function defineKeyframes(keyframes: Keyframes): Keyframes
+export function defineSelector(selector: Selector): Selector
+export function defineShortcut(shortcut: Shortcut): Shortcut
+export function defineVariables(variables: VariablesDefinition): VariablesDefinition
+
+// Utilities
+export { log, createLogger } from './internal/utils'
+```
+
+### Engine Instance
+
+The `Engine` instance provides methods for managing the CSS generation:
+
+- `engine.setup()` - Initialize the engine with plugins
+- `engine.addPreflight(css)` - Add global CSS
+- `engine.variables` - Manage CSS variables
+- `engine.keyframes` - Manage CSS keyframes
+- `engine.selectors` - Manage CSS selectors
+- `engine.shortcuts` - Manage CSS shortcuts
+- `engine.important` - Manage important rules
+
+## Plugin Development
+
+Create custom plugins to extend PikaCSS:
+
+```typescript
+import type { Plugin } from '@pikacss/core'
+
+export function myPlugin(): Plugin {
+  return {
+    name: 'my-plugin',
+    
+    setup(api) {
+      // Add preflights
+      api.addPreflight({
+        css: '/* your global CSS */'
+      })
+      
+      // Add rules
+      api.addRule({
+        /* rule configuration */
+      })
+      
+      // Add shortcuts
+      api.addShortcut({
+        /* shortcut configuration */
+      })
+      
+      // Add variants
+      api.addVariant({
+        /* variant configuration */
+      })
+    }
+  }
+}
+```
+
+## Documentation
+
+For complete documentation, visit: [PikaCSS Documentation](https://pikacss.github.io/pikacss/)
+
+## License
+
+MIT © DevilTea

package/dist/index.cjs

@@ -119,14 +119,6 @@ function renderCSSStyleBlocks(blocks, isFormatted, depth = 0) {
 	});
 	return lines.join(lineEnd);
 }
-/* c8 ignore start */
-function defineEngineConfig(config) {
-	return config;
-}
-function definePreflight(preflight) {
-	return preflight;
-}
-/* c8 ignore end */
 
 //#endregion
 //#region src/internal/extractor.ts
@@ -356,21 +348,14 @@ function createResolveConfigFn({ pruneUnused: defaultPruneUnused = true } = {})
 		};
 	};
 }
-/* c8 ignore start */
-function defineKeyframes(keyframes$1) {
-	return keyframes$1;
-}
-/* c8 ignore end */
 
 //#endregion
 //#region src/internal/resolver.ts
 var AbstractResolver = class {
-	constructor() {
-		this._resolvedResultsMap = /* @__PURE__ */ new Map();
-		this.staticRulesMap = /* @__PURE__ */ new Map();
-		this.dynamicRulesMap = /* @__PURE__ */ new Map();
-		this.onResolved = () => {};
-	}
+	_resolvedResultsMap = /* @__PURE__ */ new Map();
+	staticRulesMap = /* @__PURE__ */ new Map();
+	dynamicRulesMap = /* @__PURE__ */ new Map();
+	onResolved = () => {};
 	get staticRules() {
 		return [...this.staticRulesMap.values()];
 	}
@@ -553,11 +538,6 @@ function resolveSelectorConfig(config) {
 		};
 	}
 }
-/* c8 ignore start */
-function defineSelector(selector) {
-	return selector;
-}
-/* c8 ignore end */
 
 //#endregion
 //#region src/internal/plugins/shortcuts.ts
@@ -680,11 +660,6 @@ function resolveShortcutConfig(config) {
 		};
 	}
 }
-/* c8 ignore start */
-function defineShortcut(shortcut) {
-	return shortcut;
-}
-/* c8 ignore end */
 
 //#endregion
 //#region src/internal/plugins/variables.ts
@@ -774,11 +749,6 @@ function normalizeVariableName(name) {
 	if (name.startsWith("--")) return name;
 	return `--${name}`;
 }
-/* c8 ignore start */
-function defineVariables(variables$1) {
-	return variables$1;
-}
-/* c8 ignore end */
 
 //#endregion
 //#region src/internal/engine.ts
@@ -807,12 +777,14 @@ async function createEngine(config = {}) {
 	return engine;
 }
 var Engine = class {
+	config;
+	pluginHooks = hooks;
+	extract;
+	store = {
+		atomicStyleIds: /* @__PURE__ */ new Map(),
+		atomicStyles: /* @__PURE__ */ new Map()
+	};
 	constructor(config) {
-		this.pluginHooks = hooks;
-		this.store = {
-			atomicStyleIds: /* @__PURE__ */ new Map(),
-			atomicStyles: /* @__PURE__ */ new Map()
-		};
 		this.config = config;
 		this.extract = createExtractFn({
 			defaultSelector: this.config.defaultSelector,
@@ -1057,6 +1029,27 @@ async function renderPreflightDefinition(payload) {
 
 //#endregion
 //#region src/index.ts
+function defineEngineConfig(config) {
+	return config;
+}
+function defineStyleDefinition(styleDefinition) {
+	return styleDefinition;
+}
+function definePreflight(preflight) {
+	return preflight;
+}
+function defineKeyframes(keyframes$1) {
+	return keyframes$1;
+}
+function defineSelector(selector) {
+	return selector;
+}
+function defineShortcut(shortcut) {
+	return shortcut;
+}
+function defineVariables(variables$1) {
+	return variables$1;
+}
 /* c8 ignore end */
 
 //#endregion
@@ -1074,6 +1067,7 @@ exports.defineKeyframes = defineKeyframes;
 exports.definePreflight = definePreflight;
 exports.defineSelector = defineSelector;
 exports.defineShortcut = defineShortcut;
+exports.defineStyleDefinition = defineStyleDefinition;
 exports.defineVariables = defineVariables;
 exports.log = log;
 exports.renderCSSStyleBlocks = renderCSSStyleBlocks;