Merge pull request #498 from no-chris/add-ultimateguitar-filer

Add Ultimate Guitar filter

README.md

@@ -8,6 +8,7 @@
 
 ## Available packages
 
-| Package name                                                                               | Desription                                               |
-| ------------------------------------------------------------------------------------------ | -------------------------------------------------------- |
-| [chord-symbol](https://github.com/no-chris/chord-symbol/tree/master/packages/chord-symbol) | The core library for parsing and rendering chord symbols |
+| Package name                                                                                                             | Desription                                               |
+| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- |
+| [chord-symbol](https://github.com/no-chris/chord-symbol/tree/master/packages/chord-symbol)                               | The core library for parsing and rendering chord symbols |
+| [chord-symbol-ultimateguitar](https://github.com/no-chris/chord-symbol/tree/master/packages/chord-symbol-ultimateguitar) | Generate Ultimate Guitar-friendly chord symbols          |

babel.config.js

@@ -4,10 +4,8 @@ const presets = [
 		'@babel/preset-env',
 		{
 			targets: {
-				browsers: 'defaults',
+				browsers: 'last 2 versions',
 			},
-			useBuiltIns: 'usage',
-			corejs: '3',
 		},
 	],
 ];

jest.config.base.js

@@ -16,4 +16,12 @@ module.exports = {
 			statements: 100,
 		},
 	},
+
+	// whitelisting local modules in the node_modules folder
+	transformIgnorePatterns: [
+		'<rootDir>.*(node_modules)(?!.*chord-symbol.*).*$',
+	],
+	moduleNameMapper: {
+		'chord-symbol': '<rootDir>/packages/chord-symbol/src/index.js',
+	},
 };

lerna.json

@@ -1,6 +1,6 @@
 {
 	"packages": ["packages/*"],
-	"version": "2.1.0",
+	"version": "3.0.0-beta.2",
 	"npmClient": "yarn",
 	"preid": "beta",
 	"changelog": {

package.json

@@ -1,8 +1,7 @@
 {
-	"name": "chord-symbol",
+	"name": "monorepo-chord-symbol",
 	"version": "2.1.0",
 	"description": "Chord symbol parser and renderer",
-	"main": "lib/chord-symbol.js",
 	"author": "Christophe Noël",
 	"license": "MIT",
 	"repository": {

packages/chord-symbol-ultimateguitar/README.md

@@ -0,0 +1,19 @@
+# ChordSymbolUltimateGuitar
+
+Modify the `ChordSymbol` output to be closer with the chord symbols accepted by the Ultimate Guitar website.
+If you use `ChordSymbol` to generate chord charts to be submitted on this website, you definitely want to use this filter.
+
+## Usage
+
+```javascript
+import { chordParserFactory, chordRendererFactory } from 'chord-symbol';
+import chordSymbolUltimateGuitar from '../src/chordSymbolUltimateGuitar';
+
+const parsed = chordParserFactory()('C7(#9)');
+const rendered = chordRendererFactory({
+	customFilters: [chordSymbolUltimateGuitar()],
+	useShortNamings: true,
+})(parsed);
+
+// C7#9
+```

packages/chord-symbol-ultimateguitar/babel.config.js

@@ -0,0 +1,13 @@
+/* eslint-env node */
+const presets = [
+	[
+		'@babel/preset-env',
+		{
+			targets: {
+				browsers: 'last 2 versions',
+			},
+		},
+	],
+];
+
+module.exports = { presets };

packages/chord-symbol-ultimateguitar/jest.config.js

@@ -0,0 +1,11 @@
+/* eslint-env node */
+const baseConfig = require('../../jest.config.base');
+const packageJson = require('./package');
+
+module.exports = {
+	...baseConfig,
+	name: packageJson.name,
+	displayName: packageJson.name,
+
+	rootDir: '../..',
+};

packages/chord-symbol-ultimateguitar/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "chord-symbol-ultimateguitar",
+	"version": "3.0.0-beta.2",
+	"description": "Format chord symbols in an Ultimate Guitar-friendly way",
+	"author": "Christophe Noël",
+	"homepage": "https://github.com/no-chris/chord-symbol/tree/main/packages/chord-symbol-ultimateguitar#readme",
+	"license": "MIT",
+	"main": "lib/chord-symbol-ultimateguitar.js",
+	"directories": {
+		"lib": "lib",
+		"test": "src"
+	},
+	"files": [
+		"lib"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/no-chris/chord-symbol.git"
+	},
+	"scripts": {
+		"build": "webpack"
+	},
+	"bugs": {
+		"url": "https://github.com/no-chris/chord-symbol/issues"
+	},
+	"keywords": [
+		"chord",
+		"chords",
+		"chord-parsing",
+		"guitar",
+		"guitar-chords",
+		"music",
+		"music-theory",
+		"parser",
+		"piano",
+		"ukulele"
+	],
+	"dependencies": {
+		"chord-symbol": "^3.0.0-beta.0"
+	}
+}

packages/chord-symbol-ultimateguitar/src/chordSymbolUltimateGuitar.js

@@ -0,0 +1,12 @@
+const chordSymbolUltimateGuitar = () => {
+	return (chord) => {
+		chord.formatted.symbol = chord.formatted.symbol
+			.replace(/[() ]/g, '')
+			.replace('mM', 'mMaj')
+			.replace('°', 'dim');
+
+		return chord;
+	};
+};
+
+export default chordSymbolUltimateGuitar;

packages/chord-symbol-ultimateguitar/tests/.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+	env: {
+		jest: true,
+		node: true,
+	},
+	rules: {
+		'no-restricted-imports': ['off'],
+		'max-len': ['off'],
+		'max-params': ['warn', { max: 6 }],
+		'max-lines': ['error', { max: 550 }],
+	},
+};

packages/chord-symbol-ultimateguitar/tests/chordSymbolUltimateGuitar.spec.js

@@ -0,0 +1,29 @@
+import {
+	chordParserFactory,
+	chordRendererFactory,
+} from '../../chord-symbol/src/index';
+import chordSymbolUltimateGuitar from '../src/chordSymbolUltimateGuitar';
+
+describe('chordSymbolUltimateGuitar', () => {
+	test('Module', () => {
+		expect(chordSymbolUltimateGuitar).toBeInstanceOf(Function);
+		expect(chordSymbolUltimateGuitar()).toBeInstanceOf(Function);
+	});
+});
+
+describe.each([
+	['remove parenthesis', 'A7(#9)', 'A7#9'],
+	['replace ° with "dim" in dim chords', 'A°', 'Adim'],
+	['replace ° with "dim" in dim7 chords', 'A7°', 'Adim7'],
+	['replace mM with "mMaj"', 'AmM7', 'AmMaj7'],
+	['remove spaces', 'C(#9)', 'Cadd#9'],
+])('%s', (title, input, output) => {
+	test(input + ' => ' + output, () => {
+		const parsed = chordParserFactory()(input);
+		const rendered = chordRendererFactory({
+			customFilters: [chordSymbolUltimateGuitar()],
+			useShortNamings: true,
+		})(parsed);
+		expect(rendered).toEqual(output);
+	});
+});

packages/chord-symbol-ultimateguitar/webpack.config.js

@@ -0,0 +1,47 @@
+/* eslint-env node */
+const path = require('path');
+
+const { CleanWebpackPlugin } = require('clean-webpack-plugin');
+
+const buildDir = 'lib';
+
+const config = {
+	target: 'web',
+	mode: 'production',
+	devtool: 'source-map',
+
+	entry: {
+		'chord-symbol-ultimateguitar': './src/chordSymbolUltimateGuitar.js',
+	},
+
+	output: {
+		filename: '[name].js',
+		path: path.resolve(process.cwd(), buildDir),
+		library: 'chord-symbol-ultimateguitar',
+		libraryTarget: 'umd',
+		// https://github.com/webpack/webpack/pull/8625
+		globalObject: "typeof self !== 'undefined' ? self : this",
+	},
+
+	optimization: {
+		minimize: false,
+	},
+
+	performance: {
+		hints: false,
+	},
+
+	plugins: [new CleanWebpackPlugin()],
+
+	module: {
+		rules: [
+			{
+				test: /\.js$/,
+				exclude: /node_modules/,
+				loader: 'babel-loader',
+			},
+		],
+	},
+};
+
+module.exports = config;

packages/chord-symbol/babel.config.js

@@ -4,10 +4,8 @@ const presets = [
 		'@babel/preset-env',
 		{
 			targets: {
-				browsers: 'defaults',
+				browsers: 'last 2 versions',
 			},
-			useBuiltIns: 'usage',
-			corejs: '3',
 		},
 	],
 ];