chaestli - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0

package.json

 {
   "name": "chaestli",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "A scss grid framework made in Switzerland and brought to you by dreipol",
@@ -10,11 +10,8 @@ "main": "_index.scss",
   "scripts": {
-    "test": "npm run build && npm run lint && npm run test-ruby && npm run test-node",
-    "test-ruby": "sass test.scss",
-    "test-node": "node-sass test.scss",
+    "test": "npm run lint && npx sass test.scss",
     "lint": "stylelint _index.scss lib/**/*.scss",
-    "clean": "rm -rf vendor",
-    "demo": "node-sass --output-style=compressed -o=demo demo/scss/index.scss",
-    "prebuild": "npm run clean && mkdir vendor",
-    "build": "npm run prebuild && rsync -rm `pwd`/node_modules/* --include=\"*.scss\" --include=\"*/\" --exclude=\"*\" vendor",
-    "prepublish": "npm test"
+    "doc": "mv docs/demo demo && npx sassdoc lib --dest docs && mv demo docs/demo",
+    "demo": "npx sass --style=compressed docs/demo/scss/index.scss:docs/demo/index.css",
+    "watch-demo": "npx sass --watch --style=compressed docs/demo/scss/index.scss:docs/demo/index.css",
+    "prepublishOnly": "npm run doc && npm test"
   },
@@ -26,3 +23,2 @@ "repository": {
   "files": [
-    "vendor",
     "lib",
@@ -48,17 +44,15 @@ "_index.scss"
   "homepage": "https://github.com/dreipol/chaestli#readme",
-  "dependencies": {
-    "@dreipol/scss-mq": "^1.0.0",
-    "@dreipol/scss-utils": "^3.0.1"
-  },
   "devDependencies": {
-    "@dreipol/stylelint-config": "^5.0.0",
-    "@dreipol/stylelint-config-bem-pattern": "^2.0.1",
-    "@dreipol/stylelint-config-order": "^3.0.0",
-    "@dreipol/stylelint-config-scss": "^2.0.1",
-    "node-sass": "4.13.1",
-    "stylelint": "^13.0.0",
-    "stylelint-order": "^4.0.0",
-    "stylelint-scss": "^3.14.2",
+    "@dreipol/scss-mq": "^2.0.0",
+    "@dreipol/stylelint-config": "^7.0.0",
+    "@dreipol/stylelint-config-bem-pattern": "^3.0.0",
+    "@dreipol/stylelint-config-order": "^4.0.0",
+    "@dreipol/stylelint-config-scss": "^3.0.0",
+    "node-sass": "4.14.1",
+    "sassdoc": "^2.7.3",
+    "stylelint": "^13.7.2",
+    "stylelint-order": "^4.1.0",
+    "stylelint-scss": "^3.18.0",
     "stylelint-selector-bem-pattern": "^2.1.0"
   }
 }

README.md

@@ -0,1 +1,3 @@
+<img src="https://raw.githubusercontent.com/dreipol/chaestli/main/logo.png" width="50%"/>
+
 # chaestli
@@ -9,13 +11,51 @@ Dreipol scss grid system
 
-# Installation
+# Documentation
 
-```bash
-npm i chaestli -S
+- [API](https://www.dreipol.dev/chaestli/)
+- [Demo](https://www.dreipol.dev/chaestli/demo)
+
+## Available mixins
+
+Chaestli exports only 3 mixins (`chaestli.container`, `chaestli.grid`, `chaestli.column`) that combined together should be enough to scaffold your grid setup. For example:
+
+```scss
+@use 'node_modules/@dreipol/chaestli';
+
+.grid {
+    .grid__container {
+        // a container having a max-with of 1024px with 16px lateral padding
+        @include chaestli.container(( width: 1024px, edge: 16px ));
+    }
+   
+    .grid__row {
+        // a grid made of 12 columns with 8px lateral gutter
+        @include chaestli.grid(( gutter: 8px, num-cols: 12 ));
+    }
+
+    .grid__small-col {
+        // two columns over 12
+        @include chaestli.column(2 span, 12 span);
+    }
+
+    .grid__medium-col {
+        // for columns over 12
+        @include chaestli.column(4 span, 12 span);
+    }
+
+    .grid__big-col {
+        // eight columns over 12
+        @include chaestli.column(8 span, 12 span);
+    }
+}
 ```
 
-# Documentation
+# Usage 
 
-While the documentation is under construction, you can find some barebone examples in the [demo page](https://dreipol.github.io/chaestli/demo)
+## Installation
 
 
+```bash
+npm i chaestli -S
+```
+
 [travis-image]:https://img.shields.io/travis/dreipol/chaestli.svg?style=flat-square
@@ -22,0 +62,0 @@ [travis-url]:https://travis-ci.org/dreipol/chaestli

No alert changes

Improved metrics

Dependency count

0

decreased by-100%

Number of lines in readme file

69

increased by137.93%

Worsened metrics

Total package byte prevSize

8716

decreased by-95.97%

Dev dependency count

11

increased by22.22%

Number of package files

6

decreased by-96.95%

Dependency changes

• - Removed@dreipol/scss-mq@^1.0.0

• - Removed@dreipol/scss-utils@^3.0.1

• - Removed@dreipol/scss-mq@1.0.0(transitive)

• - Removed@dreipol/scss-utils@3.0.3(transitive)

• - Removedinclude-media-or@1.0.4(transitive)

• - Removedsass-to-js@1.3.1(transitive)