forked from sxg133/sfdoc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sfdoc.py
56 lines (48 loc) · 2.26 KB
/
sfdoc.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
import sys
import os
import glob
import argparse
import apexparser
import sfdocmaker
import shutil
from sfdoc_settings import SFDocSettings
def parse_args():
parser = argparse.ArgumentParser(description='Create documentation for SFDC apex code.')
parser.add_argument('dirs', metavar='directories', nargs=2, help='Source and target directories')
parser.add_argument('-p', '--pattern', metavar='pattern', nargs='?', help='File pattern for apex classes', default="*.cls")
parser.add_argument('-n', '--name', metavar='name', nargs='?', help='Project name', default="Apex Documentation")
parser.add_argument('-s', '--scope', metavar='scope', nargs='?', help='The lowest scope documented (public, protected, private)', default="public")
parser.add_argument('--noindex', action='store_true', help='Do not create index file.')
parser.add_argument('--test', action='store_true', help='Do not write files, just test generator (useful if combined with verbose).')
parser.add_argument('-v', '--verbose', metavar='verbose', nargs='?', help='Verbosity level (0=none, 1=class, 2=method, 3=param)', type=int, default=0)
args = parser.parse_args()
return args
def get_files(dir, pattern="*.cls"):
files = []
os.chdir(dir)
files = [f for f in glob.glob(pattern) if not f.endswith('Test.cls')] # Ignoring test classes for now
return files
args = parse_args()
SFDocSettings.verbose = args.verbose
SFDocSettings.test = args.test
SFDocSettings.indexfile = 'index.html' if not args.noindex else ''
SFDocSettings.project_name = args.name
if args.scope.lower() == 'protected':
SFDocSettings.scope = ['public', 'protected']
elif args.scope.lower() == 'private':
SFDocSettings.scope = ['public', 'protected', 'private']
[source, target] = args.dirs;
currentdir = os.path.dirname(os.path.realpath(__file__))
files = get_files(source, args.pattern)
classes = [apexparser.parse_file(f) for f in files]
classlist = [cinfo.name for cinfo in classes]
os.chdir(currentdir)
if not os.path.exists(target) and not SFDocSettings.test:
os.makedirs(target)
for c in classes:
sfdocmaker.create_outfile(classlist, c, target + '/' + c.name + '.html')
if not args.noindex:
sfdocmaker.create_index(classes, target + '/index.html')
if not SFDocSettings.test:
shutil.copy('sfdoc.css', target)
shutil.copy('normalize.css', target)