remove need to add generated libs to git

grantsheen · Jul 13, 2016 · adf76a2 · adf76a2
1 parent 025c8df
commit adf76a2
Show file tree

Hide file tree

Showing 9 changed files with 8 additions and 18 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@
 /src_vulcanize
 *.deps.js
 .tmp
+/src/generated_libs
diff --git a/gulpfile.ls b/gulpfile.ls
@@ -17,6 +17,7 @@ require! {
   'del'
   'deepcopy'
   'js-yaml'
+  'mkdirp'
 }
 
 gen_deps = require './scripts/generate_polymer_dependencies_lib.ls'
@@ -313,14 +314,15 @@ gulp.task 'generate_polymer_dependencies', (done) ->
   done()
 
 gulp.task 'generate_libs_frontend', (done) ->
+  mkdirp.sync 'src/generated_libs/libs_frontend'
   for lib_name in function_signatures.list_libs()
     lib_contents = """// This file is generated from libs_common/function_signatures.ls
     // Do not edit this file directly. To regenerate, run gulp
     const {import_lib} = require('libs_frontend/import_lib');
     module.exports = import_lib('#{lib_name}');
 
     """
-    fs.writeFileSync "src/libs_frontend/#{lib_name}.js", lib_contents
+    fs.writeFileSync "src/generated_libs/libs_frontend/#{lib_name}.js", lib_contents
   done()
 
 gulp.task 'build_base', gulp.parallel('generate_polymer_dependencies', 'generate_libs_frontend', 'yaml_build', 'copy_build') #tasks_and_patterns.map((.0))
@@ -428,6 +430,7 @@ gulp.task 'clean', ->
     'dist'
     'src_vulcanize'
     'src_gen'
+    'src/generated_libs'
   ]
 
 #gulp.task 'build_then_lint', ['webpack_watch', 'webpack_content_scripts_watch'], ->

diff --git a/package.json b/package.json
@@ -59,6 +59,7 @@
     "karma-webpack": "^1.7.0",
     "livescript": "^1.5.0",
     "livescript-loader": "^0.1.5",
+    "mkdirp": "^0.5.1",
     "mocha": "^2.5.3",
     "optionator": "^0.8.1",
     "rewire": "^2.5.2",

diff --git a/readme.md b/readme.md
@@ -208,7 +208,7 @@ Next, for all functions in that library you wish to expose to content scripts, a
 }
 ```
 
-Now, run `gulp`. It will generate a library under [`libs_frontend`](https://github.com/habitlab/habitlab-chrome/tree/master/src/libs_frontend) that imports the functions from the exposed background library. See  [`libs_frontend/tab_utils.js`](https://github.com/habitlab/habitlab-chrome/blob/master/src/libs_frontend/tab_utils.js) for an example. Remember to add it via git.
+Now, run `gulp`. It will generate a library that imports the functions from the exposed background library (it will be under `src/generated_libs/libs_frontend` but you should not need to ever look at it).
 
 Now you can use the library in your content scripts as follows (note that all functions are asynchronous and will return a promise).
 

diff --git a/src/libs_frontend/db_utils.js b/src/libs_frontend/db_utils.js
diff --git a/src/libs_frontend/intervention_utils.js b/src/libs_frontend/intervention_utils.js
diff --git a/src/libs_frontend/log_utils.js b/src/libs_frontend/log_utils.js
diff --git a/src/libs_frontend/tab_utils.js b/src/libs_frontend/tab_utils.js
diff --git a/webpack.config.ls b/webpack.config.ls
@@ -88,6 +88,7 @@ module.exports = {
     }
     fallback: [
       fromcwd('src')
+      fromcwd(path.join('src', 'generated_libs'))
     ]
   }
   node: {
-Original file line number
+Diff line change
@@ Expand Up @@
     }
     ```
-    Now, run `gulp`. It will generate a library under [`libs_frontend`](https://github.com/habitlab/habitlab-chrome/tree/master/src/libs_frontend) that imports the functions from the exposed background library. See  [`libs_frontend/tab_utils.js`](https://github.com/habitlab/habitlab-chrome/blob/master/src/libs_frontend/tab_utils.js) for an example. Remember to add it via git.
+    Now, run `gulp`. It will generate a library that imports the functions from the exposed background library (it will be under `src/generated_libs/libs_frontend` but you should not need to ever look at it).
     Now you can use the library in your content scripts as follows (note that all functions are asynchronous and will return a promise).
@@ Expand Down @@