From b7151a9195a825261035e7286582d6a1dacc50a8 Mon Sep 17 00:00:00 2001 From: Marco Montalbano Date: Thu, 3 Sep 2020 20:53:20 +0200 Subject: [PATCH] Rename package to 'output-styles-as-sass' (#59) --- .../.npmignore | 0 .../README.md | 14 ++++++------- .../package.json | 4 ++-- .../src/index.test.ts | 0 .../src/index.ts | 4 ++-- packages/output-styles-as-sass/src/types.ts | 1 + .../src/utils.test.ts | 20 +++++++++---------- .../src/utils.ts | 10 +++++----- .../tsconfig.json | 0 packages/output-styles-as-scss/src/types.ts | 1 - 10 files changed, 27 insertions(+), 27 deletions(-) rename packages/{output-styles-as-scss => output-styles-as-sass}/.npmignore (100%) rename packages/{output-styles-as-scss => output-styles-as-sass}/README.md (71%) rename packages/{output-styles-as-scss => output-styles-as-sass}/package.json (85%) rename packages/{output-styles-as-scss => output-styles-as-sass}/src/index.test.ts (100%) rename packages/{output-styles-as-scss => output-styles-as-sass}/src/index.ts (97%) create mode 100644 packages/output-styles-as-sass/src/types.ts rename packages/{output-styles-as-scss => output-styles-as-sass}/src/utils.test.ts (92%) rename packages/{output-styles-as-scss => output-styles-as-sass}/src/utils.ts (76%) rename packages/{output-styles-as-scss => output-styles-as-sass}/tsconfig.json (100%) delete mode 100644 packages/output-styles-as-scss/src/types.ts diff --git a/packages/output-styles-as-scss/.npmignore b/packages/output-styles-as-sass/.npmignore similarity index 100% rename from packages/output-styles-as-scss/.npmignore rename to packages/output-styles-as-sass/.npmignore diff --git a/packages/output-styles-as-scss/README.md b/packages/output-styles-as-sass/README.md similarity index 71% rename from packages/output-styles-as-scss/README.md rename to packages/output-styles-as-sass/README.md index 059a068e..98195ff8 100644 --- a/packages/output-styles-as-scss/README.md +++ b/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 ``` diff --git a/packages/output-styles-as-scss/package.json b/packages/output-styles-as-sass/package.json similarity index 85% rename from packages/output-styles-as-scss/package.json rename to packages/output-styles-as-sass/package.json index ac618827..1869dc1b 100644 --- a/packages/output-styles-as-scss/package.json +++ b/packages/output-styles-as-sass/package.json @@ -1,5 +1,5 @@ { - "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", @@ -7,7 +7,7 @@ "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 ", "license": "MIT", diff --git a/packages/output-styles-as-scss/src/index.test.ts b/packages/output-styles-as-sass/src/index.test.ts similarity index 100% rename from packages/output-styles-as-scss/src/index.test.ts rename to packages/output-styles-as-sass/src/index.test.ts diff --git a/packages/output-styles-as-scss/src/index.ts b/packages/output-styles-as-sass/src/index.ts similarity index 97% rename from packages/output-styles-as-scss/src/index.ts rename to packages/output-styles-as-sass/src/index.ts index a4c99332..bca2f224 100644 --- a/packages/output-styles-as-scss/src/index.ts +++ b/packages/output-styles-as-sass/src/index.ts @@ -1,6 +1,6 @@ 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'); @@ -8,7 +8,7 @@ import makeDir = require('make-dir'); type Options = { output: string; - getExtension?: () => VariableType; + getExtension?: () => Extension; getFilename?: () => string; } diff --git a/packages/output-styles-as-sass/src/types.ts b/packages/output-styles-as-sass/src/types.ts new file mode 100644 index 00000000..2a06e578 --- /dev/null +++ b/packages/output-styles-as-sass/src/types.ts @@ -0,0 +1 @@ +export type Extension = 'SASS' | 'SCSS'; diff --git a/packages/output-styles-as-scss/src/utils.test.ts b/packages/output-styles-as-sass/src/utils.test.ts similarity index 92% rename from packages/output-styles-as-scss/src/utils.test.ts rename to packages/output-styles-as-sass/src/utils.test.ts index 4308c453..f2a61dd8 100644 --- a/packages/output-styles-as-scss/src/utils.test.ts +++ b/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,7 +25,7 @@ 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'); }); @@ -33,7 +33,7 @@ describe('utils', () => { 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,7 +90,7 @@ 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'); }); @@ -98,7 +98,7 @@ describe('utils', () => { 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( diff --git a/packages/output-styles-as-scss/src/utils.ts b/packages/output-styles-as-sass/src/utils.ts similarity index 76% rename from packages/output-styles-as-scss/src/utils.ts rename to packages/output-styles-as-sass/src/utils.ts index a52c1999..ae55a881 100644 --- a/packages/output-styles-as-scss/src/utils.ts +++ b/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,9 +14,9 @@ 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': @@ -24,11 +24,11 @@ const createVariable = (name: string, value: string, type: VariableType): string } }; -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)} `); } diff --git a/packages/output-styles-as-scss/tsconfig.json b/packages/output-styles-as-sass/tsconfig.json similarity index 100% rename from packages/output-styles-as-scss/tsconfig.json rename to packages/output-styles-as-sass/tsconfig.json diff --git a/packages/output-styles-as-scss/src/types.ts b/packages/output-styles-as-scss/src/types.ts deleted file mode 100644 index 09def671..00000000 --- a/packages/output-styles-as-scss/src/types.ts +++ /dev/null @@ -1 +0,0 @@ -export type VariableType = 'SCSS' | 'SASS';