100% test coverage and improved docs.

Author: rmariuzzo

.gitignore

@@ -35,5 +35,3 @@ jspm_packages
 
 # Optional REPL history
 .node_repl_history
-
-tests/output/*

README.md

@@ -1,34 +1,53 @@
-<h1 align="center">Laravel localization Loader</h1>
-<p align="center">Laravel localization Loader for Webpack. Convert Laravel Translation files (php or json) to JavaScript Objects.</p>
+<div align=center>
+
+# Laravel localization Loader
+
+Laravel localization Loader for Webpack.
+
+Convert Laravel Translation files (php or json) to JavaScript Objects.
+
+## Features
+
+ - Support both Laravel PHP and JSON translation files.
+ - 100% test coverage.
+ - Only has two dependencies: [json-loader](https://github.com/webpack-contrib/json-loader) and [php-array-loader](https://github.com/rmariuzzo/php-array-loader).
 
 ## Installation
 
 ```shell
-npm install laravel-localization-loader
+npm install laravel-localization-loader --save-dev
+```
+
+or
+
+```shell
+yarn add laravel-localization-loader --dev
 ```
 
 ## Configuration
 
-### Webpack 2
+### Webpack 2+
 
 ```js
 // webpack.config.js
 module.exports = {
-  // ...
   module: {
     rules: [
       {
-        // Matches all PHP files in `resources/lang` directory.
+        // Matches all PHP or JSON files in `resources/lang` directory.
         test: /resources\/lang.+\.(php|json)$/,
         loader: 'laravel-localization-loader',
       }
     ]
-  },
-  // ...
+  }
 }
 ```
 
-## Usage with Lang.js
+## Usage
+
+### Lang.js
+
+First, you will need to install [Lang.js](https://github.com/rmariuzzo/Lang.js) then you may want to create a `messages.js` files that look as follow:
 
 ```js
 // messages.js
@@ -41,6 +60,8 @@ export default {
 }
 ```
 
+Then somewhere else in your awesome app:
+
 ```js
 // page.js
 import Lang from 'lang.js'
@@ -50,8 +71,35 @@ const lang = new Lang({ messages })
 lang.get('messages.hello')
 ```
 
-## Test
+Profit!
 
-```shell
-yarn test
-```
+## Development
+
+  1. Clone and fork this repo.
+  2. Install dependencies: yarn or npm install.
+  3. [Run tests](#test).
+  4. Prepare a pull request.
+
+### Test
+
+  - `yarn test` – to run all tests.
+  - `yarn test -- --watch` – to run all tests in watch mode.
+
+#### Coverage
+
+  - `yarn test -- --coverage` – to run all tests with coverage.
+  - `yarn test -- --coverage --watch` – to run all tests with coverage in watch mode.
+
+### Publish
+
+  1. Bump package version: `yarn version --new-version x.x.x -m 'Version %s.'`.
+  2. Publish to NPM registry: `npm publish`.
+  3. Push new tag: `git push origin --tags`.
+
+<div align=center>
+
+Made with :heart: by [Rubens Mariuzzo](https://github.com/rmariuzzo).
+
+[MIT license](LICENSE)
+
+</div>

index.js

@@ -1,12 +1,26 @@
+'use strict'
+
+/**
+ * Module dependencies.
+ * @private
+ */
+
 var phpArrayLoader = require('php-array-loader')
 var jsonLoader = require('json-loader')
 
+/**
+ * Module exports.
+ */
+
+module.exports = laravelLocalizationLoader
+
 /**
  * The Laravel Localization loader.
  * @param  {string} source The source contents.
  * @return {string}        The parsed contents.
  */
-var laravelLocalizationLoader = function(source) {
+
+function laravelLocalizationLoader(source) {
   var isPHP = ~source.indexOf('<?php')
 
   if (isPHP) {
@@ -15,5 +29,3 @@ var laravelLocalizationLoader = function(source) {
     return jsonLoader(source)
   }
 }
-
-module.exports = laravelLocalizationLoader

jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  "verbose": true,
+  "notify": false,
+  "modulePathIgnorePatterns": ["<rootDir>/tests/output/"],
+  "coveragePathIgnorePatterns": ["<rootDir>/tests/output/"]
+}

package.json

@@ -2,16 +2,26 @@
   "name": "laravel-localization-loader",
   "version": "1.0.3",
   "description": "Laravel Localization loader for webpack. Convert Laravel Translation strings to JavaScript Objects.",
-  "main": "loader/index.js",
+  "keywords": [
+    "laravel",
+    "localization",
+    "loader",
+    "webpack",
+    "webpack-loader",
+    "laravel-localization"
+  ],
+  "main": "index.js",
+  "homepage": "https://github.com/rmariuzzo/Laravel-localization-loader",
   "repository": "git@github.com:rmariuzzo/laravel-localization-loader.git",
   "author": "Rubens Mariuzzo <rubens@mariuzzo.com>",
   "license": "MIT",
   "scripts": {
-    "test": "jest --config tests/jest.config.json"
+    "test": "jest"
   },
   "devDependencies": {
-    "jest": "^19.0.2",
-    "webpack": "^2.2.1",
+    "jest": "^21.2.1",
+    "tmp": "^0.0.33",
+    "webpack": "^3.8.1",
     "webpack-merge": "^4.0.0"
   },
   "dependencies": {

tests/fixtures/resources/lang/en/messages.json

@@ -0,0 +1,7 @@
+{
+  "string": "Rubens",
+  "number": 123,
+  "parent": {
+    "child": "Mariuzzo"
+  }
+}

tests/jest.config.json

@@ -1,24 +1,71 @@
-var path = require('path')
-var merge = require('webpack-merge')
-var webpack = require('webpack')
+'use strict'
 
-test('should load PHP Laravel translation file', () => {
-  return runWebpack({
-    entry: path.join(__dirname, './fixtures/resources/lang/en/messages.php'),
+/**
+ * Test dependencies.
+ */
+
+const tmp = require('tmp')
+const path = require('path')
+const merge = require('webpack-merge')
+const webpack = require('webpack')
+
+/**
+ * Test cases.
+ */
+
+describe('laravel-localization-loader', () => {
+
+  let testDir
+
+  beforeEach(() => {
+    testDir = tmp.dirSync({ unsafeCleanup: true })
   })
-  .then((result) => {
-    expect(result).toBeDefined()
-    expect(result).toHaveProperty('string', 'Rubens')
-    expect(result).toHaveProperty('number', 123)
-    expect(result).toHaveProperty('parent.child', 'Mariuzzo')
+
+  afterEach(() => {
+    testDir.removeCallback()
+  })
+
+  it('should load PHP Laravel translation file', () => {
+    return runWebpack(testDir.name, {
+      entry: path.join(__dirname, './fixtures/resources/lang/en/messages.php'),
+    })
+    .then((result) => {
+      expect(result).toBeDefined()
+      expect(result).toHaveProperty('string', 'Rubens')
+      expect(result).toHaveProperty('number', 123)
+      expect(result).toHaveProperty('parent.child', 'Mariuzzo')
+    })
+  })
+  it('should load JSON Laravel translation file', () => {
+    return runWebpack(testDir.name, {
+      entry: path.join(__dirname, './fixtures/resources/lang/en/messages.json'),
+    })
+    .then((result) => {
+      expect(result).toBeDefined()
+      expect(result).toHaveProperty('string', 'Rubens')
+      expect(result).toHaveProperty('number', 123)
+      expect(result).toHaveProperty('parent.child', 'Mariuzzo')
+    })
   })
 })
 
-function runWebpack(config) {
+/**
+ * Test utilities.
+ */
+
+/**
+ * Run webpack with a default configuration.
+ * @param {Object} config Optional configuration to be merged.
+ * @return {Promise}
+ */
+
+function runWebpack(outputDir, config) {
   return new Promise((resolve, reject) => {
-    var webpackConfig = merge({
+
+    // Merge default webpack configuration with any provided.
+    const webpackConfig = merge({
       output: {
-        path: path.join(__dirname, 'output'),
+        path: outputDir,
         filename: 'translation.js',
         libraryTarget: 'umd',
       },
@@ -37,16 +84,23 @@ function runWebpack(config) {
       }
     }, config)
 
+    // Run webpack.
     webpack(webpackConfig, (webpackError, stats) => {
-      var error = webpackError ||
+
+      // Check for webpack errors.
+      const error = webpackError ||
         (stats.hasErrors() && stats.compilation.errors[0]) ||
         (stats.hasWarnings() && stats.compilation.warnings[0])
+
       if (error) {
         return reject(error)
       }
 
-      delete require.cache[path.resolve(__dirname, './output/translation.js')]
-      return resolve(require('./output/translation.js'))
+      // Remove webpack output from Node require's cache.
+      delete require.cache[`${outputDir}/translation.js`]
+
+      // Resolve with the recente webpack's output.
+      return resolve(require(`${outputDir}/translation.js`))
     })
   })
 }