@unsass/breakpoint 1.0.0 → 2.0.0

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.0](https://github.com/unsass/breakpoint/compare/v1.0.0...v2.0.0) (2022-06-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* move main files on `src` folder
+
+### Code Refactoring
+
+* move main files on `src` folder ([3307439](https://github.com/unsass/breakpoint/commit/3307439cb7fb7b6d4a67b32eabcbff19c604ccb6))
+
 ## 1.0.0 (2022-02-28)
 
 

package/README.md

@@ -2,12 +2,16 @@
 
 [![Version](https://flat.badgen.net/npm/v/@unsass/breakpoint)](https://www.npmjs.com/package/@unsass/breakpoint)
 [![Downloads](https://flat.badgen.net/npm/dt/@unsass/breakpoint)](https://www.npmjs.com/package/@unsass/breakpoint)
-[![License](https://flat.badgen.net/github/license/@unsass/breakpoint)](https://flat.badgen.net/github/license/@unsass/breakpoint)
+[![License](https://flat.badgen.net/npm/license/@unsass/breakpoint)](https://www.npmjs.com/package/@unsass/breakpoint)
 
 ## Introduction
 
 Easily manage your CSS breakpoint rules.
 
+> **Note:** this is new code moved
+> from [`@sass-collective/breakpoint`](https://github.com/sass-collective/sass-collective/tree/master/packages/breakpoint)
+> repository.
+
 ## Installing
 
 ```shell
@@ -82,6 +86,8 @@ with mixins.
 #### Declare config with `breakpoint.config()`
 
 ```scss
+@use "@unsass/breakpoint";
+
 // Extend the default list...
 @include breakpoint.config((
     "3xl": 1980px

package/index.scss

@@ -1,7 +1,7 @@
 // ============================================================================================= //
-//                                             INDEX                                             //
+//                                          BREAKPOINT                                           //
 // ============================================================================================= //
 
-@forward "./variables";
-@forward "./mixins";
-@forward "./functions" hide get-next, set-min, set-max;
+@forward "./src/variables";
+@forward "./src/mixins";
+@forward "./src/functions" hide get-next, set-min, set-max;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@unsass/breakpoint",
-    "version": "1.0.0",
+    "version": "2.0.0",
     "description": "Easily manage your CSS breakpoint rules.",
     "scripts": {
         "lint:css": "stylelint --fix \"**/*.scss\"",
@@ -13,30 +13,32 @@
         "node": ">=14.0.0",
         "npm": ">=8.0.0"
     },
+    "sass": "index.scss",
     "devDependencies": {
-        "@commitlint/cli": "^16.2.1",
-        "@commitlint/config-conventional": "^16.2.1",
+        "@commitlint/cli": "^17.0.2",
+        "@commitlint/config-conventional": "^17.0.2",
         "@semantic-release/changelog": "^6.0.1",
         "@semantic-release/git": "^10.0.1",
-        "@types/node": "^17.0.21",
+        "@types/node": "^17.0.41",
         "glob": "^7.2.0",
-        "husky": "^7.0.4",
-        "jest": "^27.5.1",
+        "husky": "^8.0.1",
+        "jest": "^28.1.1",
         "npm-run-all": "^4.1.5",
-        "sass-true": "^6.1.0-beta.1",
-        "semantic-release": "^19.0.2",
-        "stylelint": "^14.5.3",
+        "sass-true": "^6.1.0",
+        "semantic-release": "^19.0.3",
+        "stylelint": "^14.9.0",
         "stylelint-config-unsass": "^1.0.0"
     },
     "dependencies": {
         "@sass-collective/strip-unit": "^3.1.2",
-        "sass": "^1.49.9"
+        "sass": "^1.52.3"
     },
     "keywords": [
         "breakpoint",
         "unsass",
         "sass",
-        "css"
+        "css",
+        "front-end"
     ],
     "license": "MIT",
     "homepage": "https://github.com/unsass/breakpoint#readme",
@@ -47,6 +49,11 @@
         "type": "git",
         "url": "git+https://github.com/unsass/breakpoint.git"
     },
+    "files": [
+        "src/**/*",
+        "*.scss",
+        "CHANGELOG.md"
+    ],
     "publishConfig": {
         "access": "public"
     }

package/.editorconfig

@@ -1,15 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-indent_style = space
-indent_size = 4
-trim_trailing_whitespace = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-[*.yml]
-indent_size = 2

package/.gitattributes

@@ -1 +0,0 @@
-* text=auto

package/.github/dependabot.yml

@@ -1,10 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    assignees:
-      - "borisdamevin"
-    reviewers:
-      - "borisdamevin"

package/.github/workflows/node.js.yml

@@ -1,50 +0,0 @@
-name: Node.js CI
-
-on:
-  push:
-    branches: [ main, develop ]
-  pull_request:
-    branches: [ main, develop ]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [ 14.x, 16.x ]
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-
-      - name: Install Dependencies
-        run: npm ci --ignore-scripts
-
-      - name: Test
-        run: npm run test
-
-  publish:
-    runs-on: ubuntu-latest
-    needs: test
-    if: ${{ github.ref == 'refs/heads/main' }}
-
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Install Dependencies
-        run: npm ci --ignore-scripts
-
-      - name: Release
-        run: npm run release
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx --no-install commitlint --edit 

package/.releaserc.json

@@ -1,76 +0,0 @@
-{
-    "branches": [
-        "main",
-        {
-            "name": "beta",
-            "prerelease": true
-        },
-        {
-            "name": "alpha",
-            "prerelease": true
-        }
-    ],
-    "plugins": [
-        "@semantic-release/commit-analyzer",
-        [
-            "@semantic-release/changelog",
-            {
-                "changelogTitle": "# Changelog\n\nAll notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines."
-            }
-        ],
-        "@semantic-release/npm",
-        [
-            "@semantic-release/release-notes-generator",
-            {
-                "preset": "conventionalcommits",
-                "presetConfig": {
-                    "types": [
-                        {
-                            "type": "feat",
-                            "section": "Features"
-                        },
-                        {
-                            "type": "fix",
-                            "section": "Bug Fixes"
-                        },
-                        {
-                            "type": "chore",
-                            "hidden": true
-                        },
-                        {
-                            "type": "build",
-                            "section": "Build System"
-                        },
-                        {
-                            "type": "docs",
-                            "hidden": true
-                        },
-                        {
-                            "type": "style",
-                            "hidden": true
-                        },
-                        {
-                            "type": "refactor",
-                            "section": "Code Refactoring"
-                        },
-                        {
-                            "type": "perf",
-                            "hidden": true
-                        },
-                        {
-                            "type": "test",
-                            "hidden": true
-                        }
-                    ]
-                }
-            }
-        ],
-        [
-            "@semantic-release/git",
-            {
-                "message": "chore(release): publish version ${nextRelease.version}"
-            }
-        ],
-        "@semantic-release/github"
-    ]
-}

package/.stylelintignore

@@ -1,5 +0,0 @@
-## Files
-*.spec.scss
-
-## Folders
-/tests

package/.stylelintrc

@@ -1,8 +0,0 @@
-{
-    "extends": [
-        "stylelint-config-unsass"
-    ],
-    "rules": {
-        "function-no-unknown": null
-    }
-}

package/commitlint.config.js

@@ -1,9 +0,0 @@
-// ============================================================================================= //
-//                                          COMMITLINT                                           //
-// ============================================================================================= //
-
-module.exports = {
-    extends: [
-        '@commitlint/config-conventional'
-    ]
-};

package/tests/functions.spec.scss

@@ -1,24 +0,0 @@
-// ============================================================================================= //
-//                                             TEST                                              //
-// ============================================================================================= //
-
-@use "true" as *;
-@use "../index" as breakpoint;
-
-@include describe("breakpoint.get-value()") {
-    @include it("Should return value from token.") {
-        @include assert {
-            @include output(false) {
-                .foo {
-                    width: breakpoint.get-value(lg);
-                }
-            }
-
-            @include expect(false) {
-                .foo {
-                    width: 960px;
-                }
-            }
-        }
-    }
-}

package/tests/mixins.spec.scss

@@ -1,144 +0,0 @@
-// ============================================================================================= //
-//                                             TEST                                              //
-// ============================================================================================= //
-
-@use "true" as *;
-@use "../index" as breakpoint;
-
-@include describe("breakpoint.up()") {
-    @include it("Should return breakpoint 'up' rules.") {
-        @include assert {
-            @include output(false) {
-                .foo {
-                    @include breakpoint.up(lg) {
-                        color: darkcyan;
-                    }
-                }
-            }
-
-            @include expect(false) {
-                @media (min-width: 960px) {
-                    .foo {
-                        color: darkcyan;
-                    }
-                }
-            }
-        }
-    }
-}
-
-@include describe("breakpoint.down()") {
-    @include it("Should return breakpoint 'down' rules.") {
-        @include assert {
-            @include output(false) {
-                .foo {
-                    @include breakpoint.down(lg) {
-                        color: darkcyan;
-                    }
-                }
-            }
-
-            @include expect(false) {
-                @media (max-width: 959px) {
-                    .foo {
-                        color: darkcyan;
-                    }
-                }
-            }
-        }
-    }
-}
-
-@include describe("breakpoint.only()") {
-    @include it("Should return breakpoint 'only' rules.") {
-        @include assert {
-            @include output(false) {
-                .foo {
-                    @include breakpoint.only(lg) {
-                        color: darkcyan;
-                    }
-                }
-            }
-
-            @include expect(false) {
-                @media (min-width: 960px) and (max-width: 1199px) {
-                    .foo {
-                        color: darkcyan;
-                    }
-                }
-            }
-        }
-    }
-}
-
-@include describe("breakpoint.between()") {
-    @include it("Should return breakpoint 'between' rules.") {
-        @include assert {
-            @include output(false) {
-                .foo {
-                    @include breakpoint.between(md, xl) {
-                        color: darkcyan;
-                    }
-                }
-            }
-
-            @include expect(false) {
-                @media (min-width: 768px) and (max-width: 1199px) {
-                    .foo {
-                        color: darkcyan;
-                    }
-                }
-            }
-        }
-    }
-}
-
-@include describe("breakpoint.config()") {
-    @include it("Should return breakpoint 'config' rules.") {
-        @include assert {
-            @include output(false) {
-                @include breakpoint.config((
-                    "3xl": 1980px
-                ));
-
-                .foo {
-                    @include breakpoint.up("3xl") {
-                        color: darkcyan;
-                    }
-                }
-            }
-
-            @include expect(false) {
-                @media (min-width: 1980px) {
-                    .foo {
-                        color: darkcyan;
-                    }
-                }
-            }
-        }
-    }
-
-    @include it("Should return breakpoint 'config' rules with '$reset' option.") {
-        @include assert {
-            @include output(false) {
-                @include breakpoint.config((
-                    "tablet": 768px
-                ), true);
-
-                .foo {
-                    @include breakpoint.up("tablet") {
-                        color: darkcyan;
-                    }
-                }
-            }
-
-            @include expect(false) {
-                @media (min-width: 768px) {
-                    .foo {
-                        color: darkcyan;
-                    }
-                }
-            }
-        }
-    }
-}

package/tests/scss.spec.js

@@ -1,44 +0,0 @@
-// ============================================================================================= //
-//                                             TESTS                                             //
-// ============================================================================================= //
-
-const path = require('path');
-const sassTrue = require('sass-true');
-const glob = require('glob');
-
-/**
- *
- * @param url
- * @param prev
- * @param done
- * @returns {{file: string}}
- */
-function importer(url, prev, done) {
-    if (url[0] === '~') {
-        url = path.resolve('node_modules', url.substr(1));
-    }
-
-    return {
-        file: url
-    };
-}
-
-describe('Sass', () => {
-    // Find all the Sass files that end in `*.spec.scss` in any directory of this project.
-    // I use path.resolve because True requires absolute paths to compile test files.
-    const sassTestFiles = glob.sync(path.resolve(process.cwd(), '**/*.spec.scss'));
-
-    // Run True on every file found with to describe and its methods provided
-    sassTestFiles.forEach((file) =>
-        sassTrue.runSass({
-            importer,
-            file,
-            includePaths: [
-                './node_modules'
-            ]
-        }, {
-            describe,
-            it
-        })
-    );
-});