Skip to content

Commit

Permalink
refactor: rename preset-theme package to preset-base
Browse files Browse the repository at this point in the history
  • Loading branch information
jmjuanes committed Jul 2, 2022
1 parent 44b2edb commit bdc0948
Show file tree
Hide file tree
Showing 17 changed files with 36 additions and 41 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Along with the main `siimple` package, the packages listed in the table below ar
| [@siimple/core](https://github.com/jmjuanes/siimple/tree/main/packages/core/) | Core engine of the siimple CSS toolkit. | :heavy_check_mark: |
| [@siimple/modules](https://github.com/jmjuanes/siimple/tree/main/packages/modules/) | Core modules of siimple. | :heavy_check_mark: |
| [@siimple/colors](https://github.com/jmjuanes/siimple/tree/main/packages/colors/) | Color palette for siimple. | :heavy_check_mark: |
| [@siimple/preset-theme](https://github.com/jmjuanes/siimple/tree/main/packages/preset-theme/) | Default theme of siimple. | :heavy_check_mark: |
| [@siimple/preset-base](https://github.com/jmjuanes/siimple/tree/main/packages/preset-base/) | Base theme of siimple. | :heavy_check_mark: |

The version of these packages are different from the main `siimple` package, but follows this convention: the version `4.x.y` of `siimple` equals to version `0.x.y` of all packages published in the `@siimple` organization.

Expand Down
6 changes: 3 additions & 3 deletions docs/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is an example of a configuration file for **siimple**:

```js title=siimple.config.js
import colors from "@siimple/colors";
import theme from "@siimple/preset-theme";
import theme from "@siimple/preset-base";

export default {
...theme,
Expand Down Expand Up @@ -190,10 +190,10 @@ Styles defined in this section must follow the [styles syntax](/guides/styles) s
Presets allows you to extend **siimple** with reusable styles, mixins and theme scales.

```js title=siimple.config.js
import theme from "@siimple/preset-theme";
import base from "@siimple/preset-base";

export default {
...theme,
...base,
// ...other configuration
};
```
Expand Down
4 changes: 2 additions & 2 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ You can use the siimple CLI tool to generate your customized version of siimple.

```js title=siimple.config.js
import colors from "@siimple/colors";
import theme from "@siimple/preset-theme";
import base from "@siimple/preset-base";
export default {
useRootStyles: false,
useBorderBox: true,
prefix: "",
...theme,
...base,
colors: {
primary: colors.blue["500"],
secondary: colors.mint["600"],
Expand Down
7 changes: 1 addition & 6 deletions docs/packages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,4 @@ In addition with the original `siimple` package, we maintain the following packa

- [`@siimple/core`](/packages/core): the core and agnostic engine of **siimple**, that you can use for building your own CSS framework.
- [`@siimple/colors`](/packages/colors): our color palette.
- [`@siimple/preset-theme`](/packages/theme): our default theme primitives, that includes colors, fonts, sizes and spaces.
- [`@siimple/preset-elements`](/packages/elements): a preset for adding a collection of essential UI elements.
- [`@siimple/preset-helpers`](/packages/helpers): a preset for adding CSS modifiers.
- [`@siimple/preset-reboot`](/packages/reboot): a preset for adding CSS reset styles.
- [`@siimple/preset-markup`](/packages/markup): a preset for styling markup elements.
- [`@siimple/preset-icons`](/packages/icons): a preset for adding a collection of pure CSS icons.
- [`@siimple/preset-base`](/packages/base): our default theme primitives, that includes colors, fonts, sizes and spaces.
7 changes: 7 additions & 0 deletions docs/packages/base.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Base theme
---

import Readme from "../../packages/preset-base/README.md";

<Readme />
7 changes: 0 additions & 7 deletions docs/packages/theme.mdx

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @siimple/preset-theme
# @siimple/preset-base

Default theme preset for the **siimple CSS toolkit**.

Expand All @@ -7,15 +7,15 @@ Default theme preset for the **siimple CSS toolkit**.
Install this package using **npm**:

```bash
$ npm install --save @siimple/preset-theme
$ npm install --save @siimple/preset-base
```

## Usage

Use default theme in your `siimple.config.js` file:

```js
import theme from "@siimple/preset-theme";
import theme from "@siimple/preset-base";

export default {
// Import all default scales, breakpoints and root styles
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@siimple/preset-theme",
"name": "@siimple/preset-base",
"version": "0.0.2",
"description": "Default theme preset for the siimple css toolkit",
"description": "Base theme preset for the siimple css toolkit",
"author": "Josemi Juanes <josemi@siimple.xyz>",
"type": "module",
"license": "MIT",
Expand Down
8 changes: 4 additions & 4 deletions siimple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ Create a file called `siimple.config.js` with your configuration:

```js
import colors from "@siimple/colors";
import theme from "@siimple/preset-theme";
import base from "@siimple/preset-base";

export default {
...theme,
...base,
useRootStyles: false,
useBorderBox: true,
prefix: "",
Expand Down Expand Up @@ -161,10 +161,10 @@ This will generate:
Presets allows to extend **siimple** using reusable theme scales (like colors and fonts) and styles. Presets can be imported and used in your configuration file:

```js
import theme from "@siimple/preset-theme";
import base from "@siimple/preset-base";

export default {
...theme,
...base,
// ...other configuration
};
```
Expand Down
4 changes: 2 additions & 2 deletions siimple/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
export {css, mergeConfig, mergeStyles} from "@siimple/core";
export {injectModules} from "@siimple/modules";

// Export default theme
export {default as theme} from "@siimple/preset-theme";
// Export base theme
export {default as base} from "@siimple/preset-base";
2 changes: 1 addition & 1 deletion siimple/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"dependencies": {
"@siimple/core": "^0.0.2",
"@siimple/modules": "^0.1.0",
"@siimple/preset-theme": "^0.0.2"
"@siimple/preset-base": "^0.0.2"
},
"keywords": [
"siimple",
Expand Down
2 changes: 1 addition & 1 deletion siimple/siimple.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import theme from "@siimple/preset-theme";
import theme from "@siimple/preset-base";
// import colors from "@siimple/colors";

export default {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export const sidebarItems = [
{"group": "packages", "url": "/packages/core", "label": "@siimple/core"},
{"group": "packages", "url": "/packages/modules", "label": "@siimple/modules"},
{"group": "packages", "url": "/packages/colors", "label": "@siimple/colors"},
{"group": "packages", "url": "/packages/theme", "label": "@siimple/preset-theme"},
{"group": "packages", "url": "/packages/base", "label": "@siimple/preset-base"},
{"group": "guides", "url": "/guides/styles", "label": "Styles syntax"},
{"group": "recipes", "url": "/recipes/features", "label": "Features"},
{"group": "recipes", "url": "/recipes/footer", "label": "Footer"},
Expand Down
8 changes: 4 additions & 4 deletions website/landing/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ import {Welcome} from "../components/Welcome.js";

```js title=siimple.config.js
import colors from "@siimple/colors";
import theme from "@siimple/preset-theme";
import base from "@siimple/preset-base";

export default {
...theme,
...base,
colors: {
...theme.colors,
...base.colors,
primary: colors.royal["500"],
secondary: colors.mint["500"],
text: colors.royal["800"],
background: colors.royal["100"],
muted: colors.royal["200"],
},
fonts: {
...theme.fonts,
...base.fonts,
heading: ["Nunito", "sans-serif"],
code: ["monospace"],
},
Expand Down
4 changes: 2 additions & 2 deletions website/playground/defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ export const defaultConfig = `
// import colors from "@siimple/colors";
// You can import presets to extend siimple using reusable styles and themes
import theme from "@siimple/preset-theme";
import base from "@siimple/preset-base";
export default {
modules: {},
useBorderBox: true,
useRootStyles: true,
...theme,
...base,
styles: {
// Include your custom styles
},
Expand Down
4 changes: 2 additions & 2 deletions website/playground/worker.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ import {css} from "@siimple/core";
import colors from "@siimple/colors";
import {injectModules} from "@siimple/modules";
// import * as helpersUtils from "@siimple/preset-helpers/utils.js";
import theme from "@siimple/preset-theme";
import theme from "@siimple/preset-base";

const AsyncFunction = Object.getPrototypeOf(async () => {}).constructor;

// Available modules from siimple
const modules = {
"colors": colors,
// "preset-helpers/utils": helpersUtils,
"preset-theme": theme,
"preset-base": theme,
};

let prevConfig = null;
Expand Down

0 comments on commit bdc0948

Please sign in to comment.