gel-typography 5.1.2 → 6.0.0-beta.1

package/.editorconfig

@@ -7,7 +7,7 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
-indent_size = 4
+indent_size = 2
 indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true

package/README.md

@@ -1,12 +1,22 @@
 <h1 align="center">GEL Typography</h1>
-<p align="center">
-  <a href="https://travis-ci.org/bbc/gel-typography" target="_blank"><img src="https://travis-ci.org/bbc/gel-typography.svg?branch=master"></a>
-</p>
 <p align="center">
     A flexible code implementation of the GEL Typography.<br />
     Forms part of the <a href="https://github.com/bbc/gel-foundations" target="_blank"><b>GEL Foundations</b></a>
 </p>
 
+## Breaking Change: v6.0.0
+
+### @import, @use and @forward
+
+The `@import` directive is now deprecated in favour of `@use` and `@forward`, see [SASS documentation](https://sass-lang.com/documentation/at-rules/use/) for more information.
+
+GEL Typography has now been updated to `@use` and `@forward` to remove a large number of deprecation notices.
+
+With the new @use directive, no var, function, or mixin is placed in global scope, and they are all scoped within the file.
+
+This means that users will explicitly need to include the partial file in each file that may use its vars, functions or mixins.
+
+
 ## What is this?
 
 An implementation of the [GEL Typography Guidelines](http://www.bbc.co.uk/gel/guidelines/typography).
@@ -43,14 +53,12 @@ $ npm install --save gel-typography
 
 ```sass
 // your-app/main.scss
-@import 'node_modules/gel-sass-tools/sass-tools';
-@import 'node_modules/sass-mq/mq';
-@import 'node_modules/gel-typography/typography';
+@use 'node_modules/gel-typography/typography';
 ```
 
 ### Install manually
 
-You can install this component manually by downloading the content of this Git repo into your project and use a Sass @import to include it in your project.
+You can install this component manually by downloading the content of this Git repo into your project and use a Sass @use to include it in your project.
 
 > **Note:** you will manually need to manage the dependencies below, without these this component will fail to compile.
 
@@ -77,14 +85,12 @@ By default the GEL Typography component does not output any markup but exposes a
 }
 ```
 
-A collection of typography classes can be output by defining `$gel-type-enable--markup-output: true;` before you `@import` the typography partial.
+A collection of typography classes can be output by defining `$gel-type-enable--markup-output: true;` as you `@use` the typography partial.
 
 **Example:**
 
 ```scss
-$gel-type-enable--markup-output: true;
-
-@import "gel-typography/typography";
+@use "gel-typography/typography" with ($gel-type-enable--markup-output: true);
 ```
 
 The following configurable options are available: