Feat: use rcs-core mappings

Author: JPeer264

README.md

@@ -47,7 +47,7 @@ rcs.config.load();
 
 // if you have some generated mappings - load them!
 // you can also specify the string although it does not exist yet.
-rcs.loadMapping('./renaming_map.json');
+rcs.mapping.load('./renaming_map.json');
 
 // now with rcsCore you could e.g. ignore single variables (optional)
 rcsCore.baseLibrary.setExclude(/<%=[\s\S]+%>/);
@@ -59,22 +59,22 @@ rcs.process.auto(['**/*.js', '**/*.html', '**/*.css'], options, (err) => {
     // that's it
 
     // maybe you want to add the new selectors to your previous generated mappings
-    // do not worry, your old settings are still here, in case you used `loadMapping`
-    rcs.generateMapping('./', { overwrite: true }, (err) => {
+    // do not worry, your old settings are still here, in case you used `rcs.mapping.load`
+    rcs.mapping.generate('./', { overwrite: true }, (err) => {
         // the mapping file is now saved
     });
 });
 
 // promise
 rcs.process.auto(['**/*.js', '**/*.html', '**/*.css'], options)
-    .then(() => rcs.generateMapping('./', { overwrite: true }))
+    .then(() => rcs.mapping.generate('./', { overwrite: true }))
     .catch(console.error);
 
 // async/await
 (async () => {
     try {
         await rcs.process.auto(['**/*.js', '**/*.html', '**/*.css'], options);
-        await rcs.generateMapping('./', { overwrite: true });
+        await rcs.mapping.generate('./', { overwrite: true });
     } catch (err) {
         console.error(err);
     }
@@ -86,11 +86,11 @@ Sync:
 ```js
 const rcs = require('rename-css-selectors');
 
-rcs.loadMapping('./renaming_map.json');
+rcs.mapping.load('./renaming_map.json');
 
 try {
     rcs.process.autoSync(['**/*.js', '**/*.html', '**/*.css'], options);
-    rcs.generateMappingSync('./', { overwrite: true });
+    rcs.mapping.generateSync('./', { overwrite: true });
 } catch (err) {
     console.error(err);
 }
@@ -104,14 +104,13 @@ try {
 - [rcs.process.html](docs/api/processHtml.md)
 - [rcs.process.pug](docs/api/processPug.md)
 - [rcs.process.any](docs/api/processAny.md)
-- [rcs.generateMapping](docs/api/generateMapping.md)
-- [rcs.loadMapping](docs/api/loadMapping.md)
+- [rcs.mapping](docs/api/mapping.md)
 - [rcs.config](docs/api/config.md)
 
 ## Caveats
 
 Correctly using `rename-css-selectors` on large project means few rules should be followed.
-[This document](docs/caveats.md) explains most of them.
+[This document](https://github.com/JPeer264/node-rcs-core/blob/main/docs/caveats.md) explains most of them.
 
 # LICENSE
 

__tests__/generateMapping.ts

@@ -4,7 +4,6 @@ import fs from 'fs-extra';
 import json from 'json-extra';
 
 import reset from './helpers/reset';
-import generateMapping from '../lib/mapping/generateMapping';
 import rcs from '../lib';
 
 let testCwd;
@@ -26,48 +25,48 @@ afterEach(() => {
 });
 
 test('should create the normal mapping file', (done) => {
-  generateMapping(testCwd.name, (err) => {
+  rcs.mapping.generate(testCwd.name, (err) => {
     const cssMapping = json.readToObjSync(path.join(testCwd.name, '/renaming_map.json'), 'utf8');
 
     expect(err).toBeFalsy();
-    expect(cssMapping['.jp-block']).toBe('a');
-    expect(cssMapping['.jp-block__element']).toBe('b');
+    expect(cssMapping.selectors['.jp-block']).toBe('a');
+    expect(cssMapping.selectors['.jp-block__element']).toBe('b');
 
     done();
   });
 });
 
 test('should create the minified mapping file', (done) => {
-  generateMapping(testCwd.name, {
-    cssMapping: false,
-    cssMappingMin: true,
+  rcs.mapping.generate(testCwd.name, {
+    origValues: false,
   }, (err) => {
     const cssMappingMin = json.readToObjSync(path.join(testCwd.name, '/renaming_map_min.json'), 'utf8');
 
     expect(err).toBeFalsy();
-    expect(cssMappingMin['.a']).toBe('jp-block');
-    expect(cssMappingMin['.b']).toBe('jp-block__element');
+    expect(cssMappingMin.selectors['.a']).toBe('jp-block');
+    expect(cssMappingMin.selectors['.b']).toBe('jp-block__element');
 
     done();
   });
 });
 
 test('should create the minified mapping file with a custom name', (done) => {
-  generateMapping(testCwd.name, {
-    cssMappingMin: 'custom-name',
+  rcs.mapping.generate(testCwd.name, {
+    origValues: false,
+    fileName: 'custom-name',
   }, (err) => {
     const cssMappingMin = json.readToObjSync(path.join(testCwd.name, '/custom-name.json'), 'utf8');
 
     expect(err).toBeFalsy();
-    expect(cssMappingMin['.a']).toBe('jp-block');
-    expect(cssMappingMin['.b']).toBe('jp-block__element');
+    expect(cssMappingMin.selectors['.a']).toBe('jp-block');
+    expect(cssMappingMin.selectors['.b']).toBe('jp-block__element');
 
     done();
   });
 });
 
 test('should create the minified mapping js file', (done) => {
-  generateMapping(testCwd.name, {
+  rcs.mapping.generate(testCwd.name, {
     json: false,
   }, (err) => {
     const cssMapping = fs.readFileSync(path.join(testCwd.name, '/renaming_map.js'), 'utf8');
@@ -80,8 +79,8 @@ test('should create the minified mapping js file', (done) => {
 });
 
 test('should overwrite mapping files', (done) => {
-  generateMapping(testCwd.name, (err) => {
-    generateMapping(testCwd.name, { overwrite: true }, (err2) => {
+  rcs.mapping.generate(testCwd.name, (err) => {
+    rcs.mapping.generate(testCwd.name, { overwrite: true }, (err2) => {
       expect(err).toBeFalsy();
       expect(err2).toBeFalsy();
 
@@ -91,19 +90,19 @@ test('should overwrite mapping files', (done) => {
 });
 
 test('should not overwrite mapping files', async () => {
-  await expect(generateMapping(testCwd.name)).resolves.toBe(undefined);
-  await expect(generateMapping(testCwd.name)).rejects.toBeTruthy();
+  await expect(rcs.mapping.generate(testCwd.name)).resolves.toBe(undefined);
+  await expect(rcs.mapping.generate(testCwd.name)).rejects.toBeTruthy();
 });
 
 test('should create the custom names minified mapping file', (done) => {
-  generateMapping(testCwd.name, {
-    cssMapping: 'custom-name',
+  rcs.mapping.generate(testCwd.name, {
+    fileName: 'custom-name',
   }, (err) => {
     const cssMapping = json.readToObjSync(path.join(testCwd.name, '/custom-name.json'), 'utf8');
 
     expect(err).toBeFalsy();
-    expect(cssMapping['.jp-block']).toBe('a');
-    expect(cssMapping['.jp-block__element']).toBe('b');
+    expect(cssMapping.selectors['.jp-block']).toBe('a');
+    expect(cssMapping.selectors['.jp-block__element']).toBe('b');
 
     done();
   });

__tests__/generateMappingSync.ts

@@ -20,7 +20,7 @@ beforeEach(async () => {
     newPath: testCwd.name,
     cwd: fixturesCwd,
   });
-  await rcs.generateMapping(testCwd.name);
+  await rcs.mapping.generate(testCwd.name);
 
   reset();
 });
@@ -32,7 +32,7 @@ afterEach(() => {
 test('should load from an object', async () => {
   const cssMapping = json.readToObjSync(path.join(testCwd.name, '/renaming_map.json'), 'utf8');
 
-  rcs.loadMapping(cssMapping);
+  rcs.mapping.load(cssMapping);
 
   await rcs.process.html('**/*.html', {
     newPath: testCwd.name,
@@ -47,7 +47,7 @@ test('should load from an object', async () => {
 });
 
 test('should load from a filestring', async () => {
-  rcs.loadMapping(path.join(testCwd.name, '/renaming_map.json'));
+  await rcs.mapping.load(path.join(testCwd.name, '/renaming_map.json'));
 
   await rcs.process.html('**/*.html', {
     newPath: testCwd.name,
@@ -62,7 +62,7 @@ test('should load from a filestring', async () => {
 });
 
 test('should load nothing as it does not exist', async () => {
-  rcs.loadMapping(path.join(testCwd.name, '/doesnotexist.json'));
+  await rcs.mapping.load(path.join(testCwd.name, '/doesnotexist.json'));
 
   await rcs.process.html('**/*.html', {
     newPath: testCwd.name,
@@ -82,10 +82,11 @@ test('should load from a filestring', async () => {
     cwd: fixturesCwd,
   });
 
-  await rcs.generateMapping(testCwd.name, { cssMappingMin: true });
+  await rcs.mapping.generate(testCwd.name, { origValues: false });
 
   reset();
-  rcs.loadMapping(path.join(testCwd.name, '/renaming_map_min.json'), { origValues: false });
+
+  await rcs.mapping.load(path.join(testCwd.name, '/renaming_map_min.json'), { origValues: false });
 
   await rcs.process.html('**/*.html', {
     newPath: testCwd.name,

__tests__/integration_mapping.ts

@@ -1,18 +1,20 @@
-import rcs from 'rcs-core';
+import rcsCore from 'rcs-core';
 
-import loadMapping from '../lib/mapping/loadMapping';
+import rcs from '../lib';
 import reset from './helpers/reset';
 
 beforeEach(() => {
   reset();
 });
 
 test('should load from an object', () => {
-  loadMapping({
-    '.jp-block': 'a-class',
-    '#compressed': 'b',
+  rcs.mapping.load({
+    selectors: {
+      '.jp-block': 'a-class',
+      '#compressed': 'b',
+    },
   });
 
-  expect(rcs.selectorsLibrary.get('jp-block')).toBe('a-class');
-  expect(rcs.selectorsLibrary.get('#compressed')).toBe('b');
+  expect(rcsCore.selectorsLibrary.get('jp-block')).toBe('a-class');
+  expect(rcsCore.selectorsLibrary.get('#compressed')).toBe('b');
 });