From d9089f215c2459159cfa79c6c87a4ffbd7df2883 Mon Sep 17 00:00:00 2001 From: Jay Traband Date: Thu, 6 Aug 2015 12:45:50 -0700 Subject: [PATCH] shred and watch build tooling - v2 ( dgeni, gulp, jade) --- gulpfile.js | 11 +- public/_includes/_util-fns.jade | 5 +- public/doc-shredder/regionExtractor.js | 3 +- public/doc-shredder/test/LICENSE | 201 ------------------------- public/doc-shredder/test/README.md | 2 + public/doc-shredder/test/package.json | 35 ----- public/docs/README.md | 6 + 7 files changed, 24 insertions(+), 239 deletions(-) delete mode 100644 public/doc-shredder/test/LICENSE create mode 100644 public/doc-shredder/test/README.md delete mode 100644 public/doc-shredder/test/package.json create mode 100644 public/docs/README.md diff --git a/gulpfile.js b/gulpfile.js index d2f49526cb..0251ed5a73 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -13,6 +13,15 @@ var shredOptions = { destDir: "_fragments" }; +/* +Within this repo generated files are checked in so that we can avoid running the +shredder over the entire _examples dir each time someone refreshes the repo +( the ‘shred-full’ gulp task). The gulp ‘serve-and-watch’ shredder is only +a ‘partial’ shredder. It only shred’s files in directories changed during +the current session. +*/ + + gulp.task('shred-full', ['shred-clean'], function() { docShredder.shred( shredOptions); }); @@ -73,4 +82,4 @@ function execCommands(cmds, options, cb) { -gulp.task('default', ['shred']); \ No newline at end of file +gulp.task('default', ['shred-full']); \ No newline at end of file diff --git a/public/_includes/_util-fns.jade b/public/_includes/_util-fns.jade index cd26fa57da..a97696820b 100644 --- a/public/_includes/_util-fns.jade +++ b/public/_includes/_util-fns.jade @@ -17,7 +17,10 @@ // HACK: to avoid having to include a path in makeTabs calls - var currentPath = current.path; -// need to back up to 'docs' + +// simple way to only take as many '../' sections as we need to back up to the 'docs' dir +// from the current document +// we will almost certainly never go 10 or 11 deep but ... - var pathToFrags = "../../../../../../../../../../../".substr(0, (currentPath.length-2)*3) + "_fragments/"; mixin makeTabs(path, fileNames, tabNames) diff --git a/public/doc-shredder/regionExtractor.js b/public/doc-shredder/regionExtractor.js index 07557b46dd..2fe6c433a7 100644 --- a/public/doc-shredder/regionExtractor.js +++ b/public/doc-shredder/regionExtractor.js @@ -13,7 +13,7 @@ module.exports = function regionExtractor() { var docStack = []; var doc = null; var nullLine = '###'; - var rx = new RegExp(nullLine + '\n', 'g'); + lines.forEach(function(line, ix) { if (isCommentLine(line, commentPrefixes)) { if (hasRegionTag(line)) { @@ -37,6 +37,7 @@ module.exports = function regionExtractor() { content = lines.slice(doc.startIx + 1).join('\n'); } // eliminate all #docregion lines + var rx = new RegExp(nullLine + '\n', 'g'); doc.content = content.replace(rx, ''); }); diff --git a/public/doc-shredder/test/LICENSE b/public/doc-shredder/test/LICENSE deleted file mode 100644 index ad410e1130..0000000000 --- a/public/doc-shredder/test/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ -Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. \ No newline at end of file diff --git a/public/doc-shredder/test/README.md b/public/doc-shredder/test/README.md new file mode 100644 index 0000000000..d49c245d9d --- /dev/null +++ b/public/doc-shredder/test/README.md @@ -0,0 +1,2 @@ +Files in the `test_source` dir may not pass current coding conventions (such as missing EOF new lines). This is deliberate so that we can test +the doc-shredder with edge conditions. \ No newline at end of file diff --git a/public/doc-shredder/test/package.json b/public/doc-shredder/test/package.json deleted file mode 100644 index 3374cba03b..0000000000 --- a/public/doc-shredder/test/package.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "name": "test-shredder", - "version": "0.0.0", - "private": true, - "description": "Documentation file shredder", - "main": "index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "repository": { - "type": "git" - }, - "author": "Jay Traband", - "licenses": [ - { - "type": "Apache", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - } - ], - "bugs": { - "url": "" - }, - "devDependencies": { - "canonical-path": "0.0.2", - "del": "^1.2.0", - "dgeni": "^0.4.0", - "dgeni-packages": "^0.10.0", - "gulp": "^3.5.6", - "gulp-watch": "^4.3.4", - "path": "^0.11.14" - }, - "contributors": [ - "Jay Traband" - ] -} diff --git a/public/docs/README.md b/public/docs/README.md new file mode 100644 index 0000000000..95d331b115 --- /dev/null +++ b/public/docs/README.md @@ -0,0 +1,6 @@ +# Why the _fragments dir is checked in + +Within this repo files generated as a result of shredding the `_examples` dir ( the contents of the `_fragments` dir) are checked in so that we can avoid running the +shredder over the entire `_examples` dir each time someone refreshes the repo ( the `shred-full` gulp task). +The gulp `serve-and-watch` shredder is only a ‘partial’ shredder. It only shred’s files in directories changed during +the current session.