Merge pull request #68 from worldbank/ssc-publication

Version 1.0 submitted

.gitignore

@@ -73,15 +73,9 @@
 
 
 #######################
-# Include some additional file formats in any output folder. You might have
-# to change the name of the Output folder to whatever it is called in your
-# project, but we strongly recommend that you only include these files in
-# a subset of the folders where you are certain no private data is ever stored.
-!/**/Output/**/*.txt
-!/**/Output/**/*.csv
-!/**/Output/**/*.xml
-!/**/Output/**/*.eps
-!/**/Output/**/*.svg
+# Some admin data in txt formet
+!/**/admin/**/*.txt
+
 
 #######################
 # Include all the files with passwords or tokens here. All files named
@@ -94,8 +88,3 @@ passwords.*
 password/
 passwords/
 .Rproj.user
-
-
-
-
-

admin/ssc-meta-info.md

@@ -0,0 +1,32 @@
+### PACKAGE NAME:
+STATA_LINTER
+
+### TITLE:
+'STATA_LINTER': tool to detect and correct bad Stata coding practices
+
+### DESCRIPTION:
+The stata_linter package provides a linter for Stata code.
+Read about what a linter is here: https://en.wikipedia.org/wiki/Lint_(software).
+The package contains a command that detects bad Stata coding practices in a do-file so that users can manually correct them.
+The command can also correct some of the issues flagged in a new do-file.
+The purpose of the command is to help users improve code clarity, readability, and organization in Stata do-files.
+This linter is based on the best practices outlined in The DIME Analytics Coding Guide published as an appendix to the book Development Research in Practice.
+See here https://worldbank.github.io/dime-data-handbook/coding.html. For more info about this linter, see https://github.com/worldbank/stata_linter.
+
+### AUTHOR:
+"DIME Analytics, DIME, The World Bank Group", [email protected]
+
+### KEYWORDS:
+- linter
+- style guide
+- code best practices
+
+### STATA VERSION REQUIREMENT:
+Stata 16
+
+### FILES REQUIRED TO BE IN PACKAGE:
+- lint.ado
+- lint.sthlp
+- stata_linter_correct.py
+- stata_linter_detect.py
+- stata_linter_utils.py

src/lint.ado

@@ -1,4 +1,4 @@
-*! version 1.0.0  12dec2022  DIME Analytics [email protected]
+*! version 1.0.0  06dec2022  DIME Analytics [email protected]
 
 capture program drop lint
 		program 	 lint

help/lint.sthlp → src/lint.sthlp

@@ -1,5 +1,5 @@
 {smcl}
-{* 9 Jun 2021}{...}
+{* 06 Dec 2022}{...}
 {hline}
 help for {hi:lint}
 {hline}

src/stata_linter_correct.py

@@ -1,4 +1,4 @@
-# version 1.0.0  12dec2022  DIME Analytics [email protected]
+# version 1.0.0  06dec2022  DIME Analytics [email protected]
 # Import packages ============
 import os
 import re

src/stata_linter_detect.py

@@ -1,4 +1,4 @@
-# version 1.0.0  12dec2022  DIME Analytics [email protected]
+# version 1.0.0  06dec2022  DIME Analytics [email protected]
 # Import packages ====================
 import os
 import re

src/stata_linter_utils.py

@@ -1,3 +1,5 @@
+# version 1.0.0  06dec2022  DIME Analytics [email protected]
+# Import packages ====================
 import re
 import pandas as pd
 import stata_linter_detect as sld