Big changes to the package

- Export the plugin as the default module to increase its compatibility
- Export the options helpers in a separated options module
- Get rid of the dist folder to publish the package

Author: elchininet

.gitignore

@@ -1,4 +1,13 @@
 node_modules/
 dist/
 .DS_Store
-coverage/
+coverage/
+/@types/
+/constants/
+/data/
+/parsers/
+/utilities/
+/index.d.ts
+/index.js
+/options.d.ts
+/options.js

.travis.yml

@@ -11,6 +11,7 @@ script:
   - rm -rf ./coverage
 before_deploy:
   - yarn build
+  - yarn copy
 deploy:
   edge: true
   provider: npm

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [3.0.0] - 2021-01-29
+
+- Export the plugin as the default module to increase its compatibility
+- Export the options helpers in a separated options module
+- Get rid of the dist folder to publish the package
+
 ## [2.0.0] - 2020-12-16
 
 - Updated packages to the latest versions and solved vulnerabilities

README.md

@@ -35,7 +35,7 @@ Basic usage
 
 ```bash
 const postcss = require('postcss');
-const { postcssRTLCSS } = require('postcss-rtlcss');
+const postcssRTLCSS = require('postcss-rtlcss');
 
 const options = { ... available options ... };
 const result = postcss([
@@ -49,7 +49,7 @@ const rtlCSS = result.css;
 
 ```bash
 import postcss from 'postcss';
-import { postcssRTLCSS } from 'postcss-rtlcss';
+import postcssRTLCSS from 'postcss-rtlcss';
 
 const options = { ... available options ... };
 const result = postcss([
@@ -318,7 +318,8 @@ The mode option has been explained in the [Output using the combined mode](#outp
 
 ```javascript
 import postcss from 'postcss';
-import { postcssRTLCSS, Mode } from 'postcss-rtlcss';
+import postcssRTLCSS from 'postcss-rtlcss';
+import { Mode } from 'postcss-rtlcss/options';
 
 const input = '... css code ...';
 const optionsCombined = { mode: Mode.combined }; // This is the default value
@@ -586,7 +587,7 @@ This option manages if the conversion will be from `LTR` to `RTL` or vice versa.
 ##### Using Source.ltr in combined mode
 
 ```javascript
-import { Mode, Source } from 'postcss-rtlcss';
+import { Mode, Source } from 'postcss-rtlcss/options';
 
 const options = {
     mode: Mode.combined,
@@ -609,7 +610,7 @@ const options = {
 ##### Using Source.rtl in override mode
 
 ```javascript
-import { Mode, Source } from 'postcss-rtlcss';
+import { Mode, Source } from 'postcss-rtlcss/options';
 
 const options = {
     mode: Mode.override,
@@ -929,7 +930,7 @@ Flip or not the selectors names of the rules without directional properties usin
 ##### Using Autorename.flexible
 
 ```javascript
-import { Autorename } from 'postcss-rtlcss';
+import { Autorename } from 'postcss-rtlcss/options';
 
 const options = {
     autoRename: Autorename.flexible
@@ -955,7 +956,7 @@ const options = {
 ##### Using Autorename.strict
 
 ```javascript
-import { Autorename } from 'postcss-rtlcss';
+import { Autorename } from 'postcss-rtlcss/options';
 
 const options = {
     autoRename: Autorename.strict
@@ -1007,7 +1008,7 @@ When `autoRename` is enabled and greedy is `true`, the strings replacements will
 ##### greedy false
 
 ```javascript
-import { Autorename } from 'postcss-rtlcss';
+import { Autorename } from 'postcss-rtlcss/options';
 
 const options = {
     autoRename: Autorename.flexible,
@@ -1030,7 +1031,7 @@ const options = {
 ##### greedy true
 
 ```javascript
-import { Autorename } from 'postcss-rtlcss';
+import { Autorename } from 'postcss-rtlcss/options';
 
 const options = {
     autoRename: Autorename.flexible,

package.json

@@ -13,16 +13,25 @@
     "postcss-rtlcss",
     "rtlcss"
   ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "index.js",
+  "types": "index.d.ts",
   "files": [
-    "dist/**/*"
+    "@types/**/*",
+    "constants/**/*",
+    "data/**/*",
+    "parsers/**/*",
+    "utilities/**/*",
+    "index.d.ts",
+    "index.js",
+    "options.d.ts",
+    "options.js"
   ],
   "scripts": {
     "test": "jest --clearCache && jest --verbose",
     "lint": "eslint src/**/*.ts",
-    "build": "webpack && tscpaths -p tsconfig.json -s ./src -o ./dist",
-    "prepare": "npm run build",
+    "copy": "cp -r ./dist/. ./",
+    "build": "webpack && tscpaths -p tsconfig.json -s ./src -o ./dist && yarn copy",
+    "prepare": "yarn build && yarn copy",
     "prepublishOnly": "npm run lint && npm run test",
     "version": "git add .",
     "postversion": "git push && git push --tags"

src/index.ts

@@ -4,9 +4,8 @@ import { initStore } from '@data/store';
 import { parseKeyFrames, parseAtRules } from '@parsers/atrules';
 import { parseRules } from '@parsers/rules';
 import { appendRules, appendKeyFrames, appendAutorenameRules } from '@utilities/rules';
-export { PluginOptions, Mode, Source, PluginStringMap, Autorename } from '@types';
 
-export const postcssRTLCSS = (options: PluginOptions = {}): Plugin => ({
+const postcssRTLCSS = (options: PluginOptions = {}): Plugin => ({
     postcssPlugin: 'postcss-rtlcss',
     Once(css: Root): void {
         initStore(options);
@@ -19,4 +18,6 @@ export const postcssRTLCSS = (options: PluginOptions = {}): Plugin => ({
     }
 });
 
-postcssRTLCSS.postcss = true;
+postcssRTLCSS.postcss = true;
+
+export default postcssRTLCSS;

src/options.ts

@@ -0,0 +1,7 @@
+import { Mode, Source, Autorename } from '@types';
+
+export default {
+    Mode,
+    Source,
+    Autorename
+};

tests/combined-autorename.test.ts

@@ -1,5 +1,6 @@
 import postcss from 'postcss';
-import { postcssRTLCSS, PluginOptions, Mode, Autorename } from '../src';
+import postcssRTLCSS from '../src';
+import { PluginOptions, Mode, Autorename } from '../src/@types';
 import { readCSSFile } from './test-utils';
 
 const baseOptions: PluginOptions = {mode: Mode.combined};

tests/combined-basic-options.test.ts

@@ -1,5 +1,6 @@
 import postcss from 'postcss';
-import { postcssRTLCSS, PluginOptions, Mode, Source } from '../src';
+import postcssRTLCSS from '../src';
+import { PluginOptions, Mode, Source } from '../src/@types';
 import { readCSSFile } from './test-utils';
 
 const baseOptions: PluginOptions = {mode: Mode.combined};

tests/combined-prefixes.test.ts

@@ -1,5 +1,6 @@
 import postcss from 'postcss';
-import { postcssRTLCSS, PluginOptions, Mode } from '../src';
+import postcssRTLCSS from '../src';
+import { PluginOptions, Mode } from '../src/@types';
 import { readCSSFile } from './test-utils';
 
 const baseOptions: PluginOptions = {mode: Mode.combined};