Finalized npm package.

Author: shinin-light

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";
+```

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/run.sh

@@ -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

index.d.ts

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

index.js

@@ -1,3 +1,8 @@
-import fs from 'fs'
-import path from "path";
-module.exports = fs.readFileSync(path.resolve(__dirname, 'default.dcignore'), 'utf8');
+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
+};