Rename package to 'output-styles-as-sass' (#59)

packages/output-styles-as-scss/README.md → packages/output-styles-as-sass/README.md

@@ -1,8 +1,8 @@
-# @figma-export/output-styles-as-scss
+# @figma-export/output-styles-as-sass
 
-> Styles Outputter for [@figma-export](https://github.com/marcomontalbano/figma-export) that exports styles to SCSS.
+> Styles Outputter for [@figma-export](https://github.com/marcomontalbano/figma-export) that exports styles to SASS and SCSS.
 
-With this outputter you can export all the styles as variables inside a `.scss` or `.sass` file.
+With this outputter you can export all the styles as variables inside a `.sass` or `.scss` file.
 
 This is a sample of the output:
 
@@ -24,7 +24,7 @@ module.exports = {
             fileId: 'RSzpKJcnb6uBRQ3rOfLIyUs5',
             onlyFromPages: ['figma-styles'],
             outputters: [
-                require('@figma-export/output-styles-as-scss')({
+                require('@figma-export/output-styles-as-sass')({
                     output: './output'
                 })
             ]
@@ -38,7 +38,7 @@ module.exports = {
 `getExtension` and `getFilename` are **optional**.
 
 ```js
-require('@figma-export/output-styles-as-scss')({
+require('@figma-export/output-styles-as-sass')({
     output: './output',
     getExtension: () => 'SCSS',
     getFilename: () => '_variables',
@@ -52,11 +52,11 @@ require('@figma-export/output-styles-as-scss')({
 Using npm:
 
 ```sh
-npm install --save-dev @figma-export/output-styles-as-scss
+npm install --save-dev @figma-export/output-styles-as-sass
 ```
 
 or using yarn:
 
 ```sh
-yarn add @figma-export/output-styles-as-scss --dev
+yarn add @figma-export/output-styles-as-sass --dev
 ```

packages/output-styles-as-scss/package.json → packages/output-styles-as-sass/package.json

@@ -1,13 +1,13 @@
 {
-    "name": "@figma-export/output-styles-as-scss",
+    "name": "@figma-export/output-styles-as-sass",
     "version": "3.0.0-alpha.1",
     "description": "Outputter for @figma-export that exports styles to SASS and SCSS",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/marcomontalbano/figma-exporter.git",
-        "directory": "packages/output-styles-as-scss"
+        "directory": "packages/output-styles-as-sass"
     },
     "author": "Marco Montalbano <me@marcomontalbano.com>",
     "license": "MIT",

packages/output-styles-as-scss/src/index.ts → packages/output-styles-as-sass/src/index.ts

@@ -1,14 +1,14 @@
 import * as FigmaExport from '@figma-export/types';
 import { writeVariable } from './utils';
-import { VariableType } from './types';
+import { Extension } from './types';
 
 import fs = require('fs');
 import path = require('path');
 import makeDir = require('make-dir');
 
 type Options = {
     output: string;
-    getExtension?: () => VariableType;
+    getExtension?: () => Extension;
     getFilename?: () => string;
 }
 

packages/output-styles-as-sass/src/types.ts

@@ -0,0 +1 @@
+export type Extension = 'SASS' | 'SCSS';

packages/output-styles-as-scss/src/utils.test.ts → packages/output-styles-as-sass/src/utils.test.ts

@@ -5,13 +5,13 @@ import { writeVariable } from './utils';
 describe('utils', () => {
     describe('writeVariable', () => {
         describe('SCSS', () => {
-            const variableType = 'SCSS';
+            const extension = 'SCSS';
 
             it('should be able to print-out simple variable', () => {
                 const text = writeVariable(
                     'This is a comment',
                     'variable-name', '#fff',
-                    variableType,
+                    extension,
                 );
 
                 expect(text).to.eql(
@@ -25,15 +25,15 @@ describe('utils', () => {
             });
 
             it('should be able to print-out simple variable with an empty comment', () => {
-                const text = writeVariable('', 'variable-name', '#fff', variableType);
+                const text = writeVariable('', 'variable-name', '#fff', extension);
                 expect(text).to.eql('\n\n$variable-name: #fff;\n');
             });
 
             it('should be able to print-out a comment in multiline', () => {
                 const text = writeVariable(
                     'This is a comment\nin two lines',
                     'variable-name', '#fff',
-                    variableType,
+                    extension,
                 );
 
                 expect(text).to.eql(
@@ -51,7 +51,7 @@ describe('utils', () => {
                 const text = writeVariable(
                     'This is a comment\nin two lines',
                     'variable-name', '(\n"color-1": #fff,\n"color-2": #000\n)',
-                    variableType,
+                    extension,
                 );
 
                 expect(text).to.eql(
@@ -70,13 +70,13 @@ describe('utils', () => {
         });
 
         describe('SASS', () => {
-            const variableType = 'SASS';
+            const extension = 'SASS';
 
             it('should be able to print-out simple variable', () => {
                 const text = writeVariable(
                     'This is a comment',
                     'variable-name', '#fff',
-                    variableType,
+                    extension,
                 );
 
                 expect(text).to.eql(
@@ -90,15 +90,15 @@ describe('utils', () => {
             });
 
             it('should be able to print-out simple variable with an empty comment', () => {
-                const text = writeVariable('', 'variable-name', '#fff', variableType);
+                const text = writeVariable('', 'variable-name', '#fff', extension);
                 expect(text).to.eql('\n\n$variable-name: #fff\n');
             });
 
             it('should be able to print-out a comment in multiline', () => {
                 const text = writeVariable(
                     'This is a comment\nin two lines',
                     'variable-name', '#fff',
-                    variableType,
+                    extension,
                 );
 
                 expect(text).to.eql(
@@ -116,7 +116,7 @@ describe('utils', () => {
                 const text = writeVariable(
                     'This is a comment\nin two lines',
                     'variable-name', '(\n"color-1": #fff,\n"color-2": #000\n)',
-                    variableType,
+                    extension,
                 );
 
                 expect(text).to.eql(

packages/output-styles-as-scss/src/utils.ts → packages/output-styles-as-sass/src/utils.ts

@@ -1,4 +1,4 @@
-import { VariableType } from './types';
+import { Extension } from './types';
 
 const sanitizeText = (text: string): string => {
     return text
@@ -14,21 +14,21 @@ const writeComment = (message: string): string => {
 };
 
 // eslint-disable-next-line consistent-return
-const createVariable = (name: string, value: string, type: VariableType): string => {
+const createVariable = (name: string, value: string, extension: Extension): string => {
     // eslint-disable-next-line default-case
-    switch (type) {
+    switch (extension) {
         case 'SCSS':
             return `$${name}: ${value};`;
         case 'SASS':
             return `$${name}: ${value.replace(/\n/g, ' ').replace(/\s\s+/g, ' ')}`;
     }
 };
 
-export const writeVariable = (comment: string, name: string, value: string, type: VariableType): string => {
+export const writeVariable = (comment: string, name: string, value: string, extension: Extension): string => {
     if (value) {
         return sanitizeText(`
             ${writeComment(comment)}
-            ${createVariable(name, value, type)}
+            ${createVariable(name, value, extension)}
         `);
     }