Merge pull request #1 from DeepCodeAI/test_npm

NPM release

Author: shinin-light

.gitignore

@@ -1 +1,2 @@
-source/
+source
+*.tgz

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 DeepCodeAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -1,7 +1,22 @@
 # dcignore
 This repository offers a default implementation of the .dcignore file and an automatic generator based on common .gitignore patterns found in https://github.com/github/gitignore
 
-# Usage
-1. Clone this repository 
-2. Copy the `default.dcignore` file into the root of your project and rename it `.dcignore`
+# CLI usage
+1. Clone this repository
+2. Copy the `full.dcignore` file into the root of your project and rename it `.dcignore`
 
+# Module usage
+1. `npm install @deepcode/dcignore`
+2. Import the module.
+3. Use the `DefaultDCIgnore` string to fill a standard .dcignore file.
+4. Use the `CustomDCIgnore` string if you need to initialize an empty .dcignore with some content.
+
+### Javascript
+```javascript
+const { DefaultDCIgnore, CustomDCIgnore } = require('@deepcode/dcignore');
+```
+
+### Typescript
+```javascript
+import { DefaultDCIgnore, CustomDCIgnore } from "@deepcode/dcignore";
+```

development.md

@@ -0,0 +1,51 @@
+# Usage
+1. Generate an updated full.dcignore file based on the generator script.
+```shell script
+$ cd <repo-location>
+$ npm run generate
+```
+2. Check the file contents in the root directory of this repository.
+```shell script
+$ cat empty.dcignore
+$ cat full.dcignore
+```
+3. Tinker with the script to fine-tune the generator or edit the output files directly
+4. Test the package locally to debug it
+6. Publish the new version once pleased with the results
+
+## Test package
+
+1. To use and debug package locally you don't need publish it to NPM registry:
+```shell script
+$ cd <repo-location>
+$ npm link
+```
+2. After that you have to create symlink to this package in the folder of the project where you want to test it:
+```shell script
+$ cd <project-location>
+$ npm link @deepcode/dcignore
+```
+3. Add package to your `package.json`:
+```json
+"dependencies": {
+  "@deepcode/dcignore": "^1.0.0"
+}
+```
+4. Now you can use this package as usual:
+```javascript
+const { DefaultDCIgnore, CustomDCIgnore } = require('@deepcode/dcignore');
+
+console.log(DefaultDCIgnore);
+```
+
+## Publishing
+
+1. Before publishing make sure you are logged in using the company credentials
+```shell script
+$ npm login
+```
+2. Publish
+```shell script
+$ cd <repo-location>
+$ npm publish --access public
+```

empty.dcignore

@@ -0,0 +1,3 @@
+# Write glob rules for ignored files.
+# Check syntax on https://deepcode.freshdesk.com/support/solutions/articles/60000531055-how-can-i-ignore-files-or-directories-
+# Check examples on https://github.com/github/gitignore

default.dcignore full.dcignoredefault.dcignore renamed to full.dcignore

@@ -1,3 +1,7 @@
+# Write glob rules for ignored files.
+# Check syntax on https://deepcode.freshdesk.com/support/solutions/articles/60000531055-how-can-i-ignore-files-or-directories-
+# Check examples on https://github.com/github/gitignore
+
 # Hidden directories
 .*/
 
@@ -207,6 +211,7 @@ public_html/hot
 *_cache/
 /cache/
 docs/
+po/*~
 
 # Processing
 applet
@@ -941,7 +946,8 @@ protected/runtime/*
 themes/classic/views/
 
 # Rust
-/target/
+debug/
+target/
 
 # Node
 logs

generator/development.md

@@ -1,6 +1,7 @@
 SCRIPT_DIR=`dirname "$0"`
 SOURCE_DIR="./source"
-OUTPUT="../default.dcignore"
+EMPTY_OUTPUT="../empty.dcignore"
+FULL_OUTPUT="../full.dcignore"
 REGEX="(^#.*)|((^|\/)\..*$)|(^.*\.[^\/]*$)|(.*src.*)"
 
 cd "$SCRIPT_DIR"
@@ -12,8 +13,19 @@ else
 	git clone https://github.com/github/gitignore.git $SOURCE_DIR
 fi
 
-echo '# Hidden directories' > $OUTPUT
-echo '.*/' >> $OUTPUT
+TOP=(
+	"# Write glob rules for ignored files."
+	"# Check syntax on https://deepcode.freshdesk.com/support/solutions/articles/60000531055-how-can-i-ignore-files-or-directories-"
+	"# Check examples on https://github.com/github/gitignore"
+)
+for ELEMENT in "${TOP[@]}"; do
+	echo -e "$ELEMENT"
+done > "$EMPTY_OUTPUT"
+for ELEMENT in "${TOP[@]}"; do
+	echo -e "$ELEMENT"
+done > "$FULL_OUTPUT"
+
+echo -e "\n# Hidden directories\n.*/" >> "$FULL_OUTPUT"
 
 while read -r file; do
 	file_name=`basename $file`
@@ -27,17 +39,17 @@ while read -r file; do
 		fi
 	done <<< `cat "$file"`
 
-	# Debug log for checking number of rules per file.	
+	# Debug log for checking number of rules per file.
 	# echo "${file_name%.*} RULES: ${#rules[@]}"
 
 	if [ ${#rules[@]} -gt 0 ] ; then
-		echo -e "\n# ${file_name%.*}" >> $OUTPUT
+		echo -e "\n# ${file_name%.*}" >> $FULL_OUTPUT
 		for r in "${rules[@]}" ; do
-		   echo "$r" >> $OUTPUT
+		   echo "$r" >> $FULL_OUTPUT
 		done
 	fi
 done <<< `find $SOURCE_DIR -name '*.gitignore'`
 
 cd ..
-echo "Parsing completed. Check '`pwd`/`basename $OUTPUT`' file for results."
+echo "Parsing completed. Check '`pwd`/`basename $FULL_OUTPUT`' file for results."
 exit 0

generator/run.sh

@@ -0,0 +1,6 @@
+export = defaultDCIgnore;
+
+declare const defaultDCIgnore: {
+    CustomDCIgnore: string;
+    DefaultDCIgnore: string;
+};

index.d.ts

@@ -0,0 +1,8 @@
+const fs = require('fs');
+const path = require('path');
+const DefaultDCIgnore = fs.readFileSync(path.resolve(__dirname, 'full.dcignore'), 'utf8');
+const CustomDCIgnore = fs.readFileSync(path.resolve(__dirname, 'empty.dcignore'), 'utf8');
+module.exports = {
+  DefaultDCIgnore,
+  CustomDCIgnore
+};