Initial commit. ⚡️

Author: oxyzero

.gitignore

@@ -0,0 +1,58 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env

README.md

@@ -1,2 +1,51 @@
 # php-arrays
-Parse PHP array-like configuration files in JavaScript.
+
+Parse PHP array-like configuration files into JavaScript objects.
+
+Sometimes it is useful to share your PHP application configuration with, for example, your JavaScript build system. Let's say the application has a theme configuration key, instead of duplicating the same key in JavaScript configuration, this package allows to transform the PHP array-like configuration file into JSON.
+
+## Quick Example
+
+```php
+<?php
+
+return [
+    'foo' => 'bar',
+];
+```
+
+```js
+let parser = require('php-arrays');
+
+parser.parse('../path/to/file.php', (result) => {
+    console.log(result); // { foo: "bar" }
+}, (error) => {
+    // Handle error..
+});
+
+let result = parser.parseSync('../path/to/file.php', (error) => {
+    return 'this will be the value of the result variable if an error occurs.';
+});
+```
+
+## Installing
+
+Run `npm install oxy/php-arrays --save-dev`.
+
+## API
+
+### parse(file : string, callback : function, onError? : function)
+
+The parse function parses the given file asynchronously. Whenever the parsing of the file is successful, the callback function will be triggered, otherwise, the optional onError function is called.
+
+### parseSync(file : string, onError? : function)
+
+The parseSync function parses the given file synchronously. If the parsing of the file provokes an error, the optional onError function is called. This function returns the PHP array as JSON or the value returned by the onError function.
+
+### command(file : string)
+
+This function allows to sanitize the file input and also generate the command to parse the file. Therefore, it returns the generated command.
+
+## Contributing
+
+If you happen to find an error, or you might be thinking about a general improvement to the project, please do create an Issue, or consider creating a Pull Request. All contributions are appreciated.

index.js

@@ -0,0 +1,67 @@
+// @ts-check
+'use strict';
+
+/**
+ * Generates the command that is necessary to parse the given file.
+ *
+ * @param {string} file PHP configuration file path (relative or absolute).
+ */
+exports.command = function (file) {
+    file = file.replace(/(["\s'$`\\])/g, '\\$1');
+
+    return `$(which php) -n -d display_errors=0 -r \'echo json_encode(include("${file}"));\'`
+};
+
+/**
+ * Parses the given file asynchronously, passing the result to the callback
+ * function. In case of failure, it triggers the optional onError callback
+ * to handle the error.
+ *
+ * @param {string} file PHP configuration file path (relative or absolute).
+ * @param {function(object, Error=, string=, string=)} callback Function that will be triggered upon parsing the file.
+ * @param {function(string)=} onError Function that will be triggered upon an error during the parsing of the file.
+ */
+exports.parse = function (file, callback, onError = (error) => {}) {
+    let sh = require('child_process');
+
+    sh.exec(this.command(file), function (err, stdout, stderr) {
+        try {
+            let result = JSON.parse(stdout.trim());
+
+            if (result) {
+                return callback(result, err, stdout, stderr);
+            }
+
+            throw new Error('Failed to parse the given file because: ' + result);
+        } catch (error) {
+            onError(error);
+        }
+    });
+};
+
+/**
+ * Parses the given file synchronously, returning the result.
+ * In case of failure, it triggers the optional onError callback to handle the error.
+ *
+ * @param {string} file PHP configuration file path (relative or absolute).
+ * @param {function(*)=} onError Function that will be triggered upon an error during the parsing of the file.
+ */
+exports.parseSync = function (file, onError = (error) => {}) {
+    let sh = require('child_process');
+
+    try {
+        let result = JSON.parse(
+            sh.execSync(
+                this.command(file)
+            ).toString().trim()
+        );
+
+        if (result) {
+            return result;
+        }
+
+        throw new Error('Failed to parse the given file because: ' + result);
+    } catch (error) {
+        return onError(error);
+    }
+}