react-fs-router 1.0.1 → 1.0.13

package/.idea/git_toolbox_prj.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="GitToolBoxProjectSettings">
+    <option name="commitMessageIssueKeyValidationOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+    <option name="commitMessageValidationEnabledOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/react-filesystem-router.iml" filepath="$PROJECT_DIR$/.idea/react-filesystem-router.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/react-filesystem-router.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -1,7 +1,6 @@
 # React-fs-router
 
-A cli library that watches a user-provided path for changes in files and folders and genarates two files to implement file-system based routing.
-
+A cli library for implementing file-system based routing in React applications.
 ## Installation
 
 Use yarn or npm to install react-fs-router
@@ -16,16 +15,16 @@ npm install react-fs-router
 
 ## Usage
 
-The position of a file in the folder structure defines it's path. Files named index are treated as the root and default file in each folder.
+The position of a file in the folder structure defines its path. Files named index are treated as the root file in each folder.
 You can define a dynamic route by placing the name of the file in brackets. ie: [id].js ==> :id
 
-| Arguments                       | Result                                                                                                        |
-| ------------------------------- | ------------------------------------------------------------------------------------------------------------- |
-| -i \| --input <directory>       | Path to watch for changes. Required.                                                                          |
-| -o \| --output <output>         | Optional argument that takes a path to place output files in. Defaults to the input directory.                |
-| -ext \| --extention <extention> | Optional argument to change the file extension of the output files. Defaults to .js .                         |
-| -p \| --pageProperties [type]   | Optional boolean argument to disable generating page_properties file. Defaults to false.                      |
-| -b \| --build [type]            | Optional boolean argument that tells the program to run once. Defaults to false. Intended for build commands. |
+| Arguments                     | Result                                                                                                        |
+|-------------------------------| ------------------------------------------------------------------------------------------------------------- |
+| -i  --input <directory>       | Path to watch for changes. Required.                                                                          |
+| -o  --output <output>         | Optional argument that takes a path to place output files in. Defaults to the input directory.                |
+| -ext  --extention <extention> | Optional argument to change the file extension of the output files. Defaults to .js .                         |
+| -p  --pageProperties [type]   | Optional boolean argument to disable generating page_properties file. Defaults to false.                      |
+| -b  --build [type]            | Optional boolean argument that tells the program to run once. Defaults to false. Intended for build commands. |
 
 ```JSON
   "scripts": {
@@ -45,7 +44,7 @@ Run react-fs-router
 npm run rfr
 ```
 
-The program will then generate two files one containing imports and exports of all the files inside the provided path and one containing an array of objects per each file. The properties in the mentioned object are as follows:
+The program will then generate two files one containing imports and exports of all the files inside the provided path and one containing an array of objects describing each file. The properties in the mentioned object are as follows:
 
 ```javascript
 
@@ -58,7 +57,7 @@ path: // The path of this file in relation to its position in the folder structu
 
 ```
 
-Name, icon and index can be written in each file and react-fs-router will read and place them in the output file.
+Name, icon and index can be written in each file as comments and react-fs-router will read and place them in the output file.
 
 ```javascript
 // name: Home
@@ -70,11 +69,6 @@ To use the generated files with react-router:
 
 ```javascript xml react
 function App() {
-  const [pages, setPages] = useState();
-
-  useEffect(() => {
-    setPages(renderConponents(Pages));
-  }, []);
 
   function renderComponent(key, module) {
     return module[key] || module["default"] || module;
@@ -98,7 +92,7 @@ function App() {
     }
     return renders;
   }
-  return <Switch>{pages}</Switch>;
+  return <Switch>{renderConponents(Pages)}</Switch>;
 }
 ```
 
@@ -112,7 +106,7 @@ Place this component inside BrowserRouter
 
 ## Using with Ant Pro Layout
 
-The routes array generated by this library can be easily used with Ant designs pro layout component.
+The properties file generated by this library can be easily used with Ant Designs pro layout component.
 The following is an example using an hoc:
 
 ```javascript xml

package/genPath.js

@@ -4,13 +4,7 @@ const chokidar = require("chokidar");
 
 let isNotThefirstTimeRunning = true;
 
-const genPath = (
-  page_directory,
-  configs_directory,
-  runOnce,
-  file_extention,
-  dont_output_fileProperties
-) => {
+const genPath = (page_directory, configs_directory, runOnce) => {
   //main function
   const pathMaker = () => {
     //parse parameters in path
@@ -156,20 +150,18 @@ const genPath = (
         else return "." + ext;
       } else return ".js";
     };
-    if (!dont_output_fileProperties) {
-      fs.writeFileSync(
-        (configs_directory || page_directory) +
-          `/_page-properties${parseFileExtention(file_extention)}`,
-        prettier.format(_config, { semi: false, parser: "babel" }),
-        (err) => {
-          if (err) return console.error(err);
-        }
-      );
-    }
+    fs.writeFileSync(
+      (configs_directory || page_directory) +
+        `/_page-properties${parseFileExtention(".js")}`,
+      prettier.format(_config, { semi: false, parser: "babel" }),
+      (err) => {
+        if (err) return console.error(err);
+      }
+    );
 
     fs.writeFileSync(
       (configs_directory || page_directory) +
-        `/_routes${parseFileExtention(file_extention)}`,
+        `/_routes${parseFileExtention(".js")}`,
       prettier.format(_routes, { semi: false, parser: "babel" }),
       (err) => {
         if (err) return console.error(err);

package/index.js

@@ -10,27 +10,10 @@ program.storeOptionsAsProperties(name);
 
 program.version(version, "-v --version", "Output the current version");
 program.requiredOption("-i,--input <directory>", "Path to your pages folder");
-program.option("-o,--output <output>", "Path to store generated files");
-program.option(
-  "-ext,--extention <extention>",
-  "extention on the generated files"
-);
-
-program.option(
-  "-p,--pageProperties [type]",
-  "Boolean option to disable genrating page properties file"
-);
 program.option(
   "-b,--build [type]",
   "Boolean Option to run the program once. Intended to be used with build commands."
 );
-
 program.parse();
 
-genPath(
-  program.input,
-  program.output,
-  program.build,
-  program.extention,
-  program.pageProperties
-);
+genPath(program.input, program.build);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-fs-router",
-  "version": "1.0.1",
+  "version": "1.0.13",
   "description": "File-system based routing for React.",
   "main": "./index.js",
   "git repository": "https://github.com/Mehran9675/react-filesystem-routing",