From 4d078b752e2c07d17c3a8078abbcfd1d2a8bd4c6 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Mon, 5 Jan 2015 10:20:48 -0800 Subject: [PATCH] formatting --- bin/dartdoc.dart | 14 ++-- lib/dartdoc.dart | 19 +++-- lib/src/css.dart | 8 +- lib/src/generator.dart | 20 +++-- lib/src/html_gen.dart | 3 +- lib/src/html_utils.dart | 17 +++- lib/src/io_utils.dart | 60 +++++++------- lib/src/model.dart | 163 +++++++++++++++++++++---------------- lib/src/package_utils.dart | 6 +- test/template_test.dart | 19 +++-- 10 files changed, 184 insertions(+), 145 deletions(-) diff --git a/bin/dartdoc.dart b/bin/dartdoc.dart index f5939fd06f..48735ff64b 100644 --- a/bin/dartdoc.dart +++ b/bin/dartdoc.dart @@ -18,8 +18,8 @@ void main(List arguments) { if (results['help']) { _printUsageAndExit(parser); } - List excludeLibraries = results['exclude'] == null ? - [] : results['exclude'].split(','); + List excludeLibraries = + results['exclude'] == null ? [] : results['exclude'].split(','); String url = results['url']; var currentDir = Directory.current; @@ -36,15 +36,11 @@ void _printUsageAndExit(ArgParser parser) { ArgParser _createArgsParser() { // TODO: more options to be added var parser = new ArgParser(); - parser.addOption( - 'exclude', + parser.addOption('exclude', help: 'a comma-separated list of library names to ignore'); - parser.addOption( - 'url', + parser.addOption('url', help: 'the url where the docs will be hosted (used to generate the sitemap)'); parser.addFlag('help', - abbr: 'h', - negatable: false, - help: 'show command help'); + abbr: 'h', negatable: false, help: 'show command help'); return parser; } diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart index 09c2913759..5f36e70381 100644 --- a/lib/dartdoc.dart +++ b/lib/dartdoc.dart @@ -24,7 +24,6 @@ const String DEFAULT_OUTPUT_DIRECTORY = 'docs'; /// Generates Dart documentation for all public Dart libraries in the given /// directory. class DartDoc { - List _excludes; Directory _rootDir; String _url; @@ -55,25 +54,32 @@ class DartDoc { out.createSync(recursive: true); } - generator = new HtmlGenerator(new Package(libraries, _rootDir.path), out, _url); + generator = new HtmlGenerator( + new Package(libraries, _rootDir.path), out, _url); // generate the docs generator.generate(); double seconds = stopwatch.elapsedMilliseconds / 1000.0; print(''); - print("Documented ${libraries.length} " "librar${libraries.length == 1 ? 'y' : 'ies'} in " "${seconds.toStringAsFixed(1)} seconds."); + print( + "Documented ${libraries.length} " "librar${libraries.length == 1 ? 'y' : 'ies'} in " "${seconds.toStringAsFixed(1)} seconds."); } List parseLibraries(List files) { DartSdk sdk = new DirectoryBasedDartSdk(new JavaFile(_getSdkDir().path)); ContentCache contentCache = new ContentCache(); - List resolvers = [new DartUriResolver(sdk), new FileUriResolver()]; - JavaFile packagesDir = new JavaFile.relative(new JavaFile(_rootDir.path), 'packages'); + List resolvers = [ + new DartUriResolver(sdk), + new FileUriResolver() + ]; + JavaFile packagesDir = new JavaFile.relative( + new JavaFile(_rootDir.path), 'packages'); if (packagesDir.exists()) { resolvers.add(new PackageUriResolver([packagesDir])); } - SourceFactory sourceFactory = new SourceFactory(/*contentCache,*/ resolvers); + SourceFactory sourceFactory = new SourceFactory( + /*contentCache,*/ resolvers); AnalysisContext context = AnalysisEngine.instance.createAnalysisContext(); context.sourceFactory = sourceFactory; @@ -104,5 +110,4 @@ class DartDoc { // Look relative to the dart executable. return new File(Platform.executable).parent.parent; } - } diff --git a/lib/src/css.dart b/lib/src/css.dart index 99bef4e20f..1b46df0829 100644 --- a/lib/src/css.dart +++ b/lib/src/css.dart @@ -15,9 +15,9 @@ class CSS { String getCssName() => 'bootstrap.css'; String getCssContent() { - var script = new File(Platform.script.toFilePath()); - var cssFile = new File('${script.parent.path}$cssFilePath'); - String text = cssFile.readAsStringSync(encoding: ASCII); - return text; + var script = new File(Platform.script.toFilePath()); + var cssFile = new File('${script.parent.path}$cssFilePath'); + String text = cssFile.readAsStringSync(encoding: ASCII); + return text; } } diff --git a/lib/src/generator.dart b/lib/src/generator.dart index 1ab6f82166..81a5f783db 100644 --- a/lib/src/generator.dart +++ b/lib/src/generator.dart @@ -29,7 +29,7 @@ body { HtmlHelper html = new HtmlHelper(); CSS css = new CSS(); HtmlGeneratorHelper helper; - List htmlFiles =[]; + List htmlFiles = []; String url; HtmlGenerator(this.package, this.out, this.url) { @@ -57,7 +57,9 @@ body { htmlFiles.add(fileName); print('generating ${f.path}'); - html.start(title: 'Package ${packageName}', cssRef: css.getCssName(), + html.start( + title: 'Package ${packageName}', + cssRef: css.getCssName(), inlineStyle: bootstrapOverrides); html.generateHeader(); html.startTag('div', attributes: "class='container'", newLine: false); @@ -67,7 +69,8 @@ body { html.startTag('div', attributes: "class='col-md-3'"); html.startTag('ul', attributes: 'class="nav nav-pills nav-stacked"'); html.startTag('li', attributes: 'class="active"', newLine: false); - html.write('' ' ' '${packageName}-${packageVersion}'); + html.write( + '' ' ' '${packageName}-${packageVersion}'); html.endTag(); //li html.endTag(); //ul html.endTag(); @@ -97,7 +100,9 @@ body { print('generating ${f.path}'); htmlFiles.add(fileName); html = new HtmlHelper(); - html.start(title: 'Library ${library.name}', cssRef: css.getCssName(), + html.start( + title: 'Library ${library.name}', + cssRef: css.getCssName(), inlineStyle: bootstrapOverrides); html.generateHeader(); @@ -111,7 +116,8 @@ body { html.startTag('div', attributes: "class='col-md-3'"); html.startTag('ul', attributes: 'class="nav nav-pills nav-stacked"'); html.startTag('li', attributes: 'class="active"', newLine: false); - html.write('' ' ' '${library.name}'); + html.write( + '' ' ' '${library.name}'); html.endTag(); // li html.endTag(); // ul.nav html.endTag(); // div.col-md-3 @@ -194,7 +200,6 @@ body { } void generateClass(Class cls) { - html.write(createAnchor(cls)); html.writeln('
'); html.startTag('h4'); @@ -444,7 +449,7 @@ body { var tmpl = tmplFile.readAsStringSync(); // TODO: adjust urls List names = htmlFiles.map((f) => {'name': '$f'}).toList(); - var content = render(tmpl, {'url': url, 'links' : names}); + var content = render(tmpl, {'url': url, 'links': names}); f.writeAsStringSync(content); } } @@ -454,7 +459,6 @@ String _getFileNameFor(Library library) { } class HtmlGeneratorHelper extends Helper { - Package package; HtmlGeneratorHelper(this.package); diff --git a/lib/src/html_gen.dart b/lib/src/html_gen.dart index c1c8dcd8f4..b89a0dc61b 100644 --- a/lib/src/html_gen.dart +++ b/lib/src/html_gen.dart @@ -35,7 +35,8 @@ class HtmlHelper { writeln(); startTag('head'); writeln(''); - writeln(''); + writeln( + ''); if (title != null) { writeln('${title}'); } diff --git a/lib/src/html_utils.dart b/lib/src/html_utils.dart index b9fbf38b76..65c32be629 100644 --- a/lib/src/html_utils.dart +++ b/lib/src/html_utils.dart @@ -5,7 +5,10 @@ library dartdoc.html_utils; String htmlEscape(String text) { - return text.replaceAll('&', '&').replaceAll('>', '>').replaceAll('<', '<'); + return text + .replaceAll('&', '&') + .replaceAll('>', '>') + .replaceAll('<', '<'); } String escapeBrackets(String text) { @@ -13,7 +16,11 @@ String escapeBrackets(String text) { } String stringEscape(String text, String quoteType) { - return text.replaceAll(quoteType, "\\${quoteType}").replaceAll('\n', '\\n').replaceAll('\r', '\\r').replaceAll('\t', '\\t'); + return text + .replaceAll(quoteType, "\\${quoteType}") + .replaceAll('\n', '\\n') + .replaceAll('\r', '\\r') + .replaceAll('\t', '\\t'); } abstract class CodeResolver { @@ -52,7 +59,8 @@ String prettifyDocs(CodeResolver resolver, String docs) { buf.write('${line}\n'); } } else if (inList) { - buf.write('
  • ${_processMarkdown(resolver, line.trim().substring(2))}
    • '); + buf.write( + '
  • ${_processMarkdown(resolver, line.trim().substring(2))}
    • '); } else if (line.trim().length == 0) { buf.write('

    \n

    '); } else { @@ -127,7 +135,8 @@ String _processMarkdown(CodeResolver resolver, String line) { return line; } -String replaceAll(String str, List matchChars, {String htmlEntity, var replaceFunction}) { +String replaceAll(String str, List matchChars, + {String htmlEntity, var replaceFunction}) { int lastWritten = 0; int index = str.indexOf(matchChars[0]); StringBuffer buf = new StringBuffer(); diff --git a/lib/src/io_utils.dart b/lib/src/io_utils.dart index 59e839a4f9..90d950f79b 100644 --- a/lib/src/io_utils.dart +++ b/lib/src/io_utils.dart @@ -16,16 +16,16 @@ import 'package:path/path.dart' as path; /// Excludes files and directories beginning with `.` /// /// The returned paths are guaranteed to begin with [dir]. -List _listDir(String dir, {bool recursive: false, - List listDir(Directory dir)}) { +List _listDir(String dir, + {bool recursive: false, List listDir(Directory dir)}) { if (listDir == null) listDir = (Directory dir) => dir.listSync(); return _doList(dir, new Set(), recursive, listDir); } File joinFile(Directory dir, List files) { - String pathFragment = files.join(Platform.pathSeparator); - return new File("${dir.path}${Platform.pathSeparator}${pathFragment}"); + String pathFragment = files.join(Platform.pathSeparator); + return new File("${dir.path}${Platform.pathSeparator}${pathFragment}"); } List _doList(String dir, Set listedDirectories, bool recurse, @@ -49,8 +49,8 @@ List _doList(String dir, Set listedDirectories, bool recurse, contents.add(entity.path); if (entity is Directory) { if (recurse) { - children.addAll(_doList(entity.path, listedDirectories, recurse, - listDir)); + children.addAll( + _doList(entity.path, listedDirectories, recurse, listDir)); } } } @@ -67,32 +67,32 @@ List findFilesToDocumentInPackage(String packageDir) { // containing '/packages' will be added. The only exception is if the file // to analyze already has a '/package' in its path. var files = _listDir(packageDir, recursive: true, listDir: _packageDirList) - .where((f) => f.endsWith('.dart') && - (!f.contains('${path.separator}packages') || - packageDir.contains('${path.separator}packages'))) - .toList(); + .where((f) => f.endsWith('.dart') && + (!f.contains('${path.separator}packages') || + packageDir.contains('${path.separator}packages'))) + .toList(); var packageLibDir = path.join(packageDir, 'lib'); var packageLibSrcDir = path.join(packageLibDir, 'src'); files.forEach((String lib) { - // Only include libraries within the lib dir that are not in lib/src - if (path.isWithin(packageLibDir, lib) && - !path.isWithin(packageLibSrcDir, lib)) { - // Only add the file if it does not contain 'part of' - // TODO(janicejl): Remove when Issue(12406) is resolved. - var contents = new File(lib).readAsStringSync(); - - if (contents.contains(new RegExp('\npart of ')) || - contents.startsWith(new RegExp('part of '))) { + // Only include libraries within the lib dir that are not in lib/src + if (path.isWithin(packageLibDir, lib) && + !path.isWithin(packageLibSrcDir, lib)) { + // Only add the file if it does not contain 'part of' + // TODO(janicejl): Remove when Issue(12406) is resolved. + var contents = new File(lib).readAsStringSync(); + + if (contents.contains(new RegExp('\npart of ')) || + contents.startsWith(new RegExp('part of '))) { // logger.warning('Skipping part "$lib". ' // 'Part files should be in "lib/src".'); - } else { - var uri = new Uri.file(path.normalize(path.absolute(lib))); - libraries.add(uri.path); + } else { + var uri = new Uri.file(path.normalize(path.absolute(lib))); + libraries.add(uri.path); // logger.info('Added to libraries: $lib'); + } } - } }); return libraries; } @@ -104,15 +104,17 @@ List findFilesToDocumentInPackage(String packageDir) { List _packageDirList(Directory dir) { var entities = dir.listSync(); - var pubspec = entities.firstWhere((e) => e is File && - path.basename(e.path) == 'pubspec.yaml', orElse: () => null); + var pubspec = entities.firstWhere( + (e) => e is File && path.basename(e.path) == 'pubspec.yaml', + orElse: () => null); - var libDir = entities.firstWhere((e) => e is Directory && - path.basename(e.path) == 'lib', orElse: () => null); + var libDir = entities.firstWhere( + (e) => e is Directory && path.basename(e.path) == 'lib', + orElse: () => null); if (pubspec != null && libDir != null) { - return [libDir]; + return [libDir]; } else { - return entities; + return entities; } } diff --git a/lib/src/model.dart b/lib/src/model.dart index 673c64077c..b122c9e6cf 100644 --- a/lib/src/model.dart +++ b/lib/src/model.dart @@ -12,7 +12,6 @@ import 'model_utils.dart'; import 'package_utils.dart'; abstract class ModelElement { - Element element; Library library; @@ -119,18 +118,20 @@ abstract class ModelElement { String createLinkedSummary(Helper generator) { if (isExecutable) { ExecutableElement ex = (element as ExecutableElement); - String retType = generator.createLinkedReturnTypeName(new ElementType(ex.type, library)); + String retType = generator.createLinkedReturnTypeName( + new ElementType(ex.type, library)); return '${generator.createLinkedName(this)}' - '(${generator.printParams(ex.parameters.map((f) => + '(${generator.printParams(ex.parameters.map((f) => new Parameter(f, library)).toList())})' - '${retType.isEmpty ? '' : ': $retType'}'; + '${retType.isEmpty ? '' : ': $retType'}'; } if (isPropertyInducer) { PropertyInducingElement pe = (element as PropertyInducingElement); StringBuffer buf = new StringBuffer(); buf.write('${generator.createLinkedName(this)}'); - String type = generator.createLinkedName(pe.type == null ? null : new ModelElement.from(pe.type.element, library)); + String type = generator.createLinkedName(pe.type == null ? null : + new ModelElement.from(pe.type.element, library)); if (!type.isEmpty) { buf.write(': $type'); } @@ -148,8 +149,10 @@ abstract class ModelElement { buf.write('static '); } - buf.write(generator.createLinkedReturnTypeName(new ElementType(e.type, library))); - buf.write(' ${e.name}(${generator.printParams(e.parameters.map((f) => new Parameter(f, library)).toList())})'); + buf.write(generator.createLinkedReturnTypeName( + new ElementType(e.type, library))); + buf.write( + ' ${e.name}(${generator.printParams(e.parameters.map((f) => new Parameter(f, library)).toList())})'); return buf.toString(); } if (isPropertyInducer) { @@ -165,7 +168,8 @@ abstract class ModelElement { buf.write('const '); } - buf.write(generator.createLinkedName(e.type == null ? null : new ModelElement.from(e.type.element, library))); + buf.write(generator.createLinkedName(e.type == null ? null : + new ModelElement.from(e.type.element, library))); buf.write(' ${e.name}'); // write out any constant value @@ -187,7 +191,6 @@ abstract class ModelElement { } class Package { - String _rootDirPath; List _libraries = []; @@ -215,12 +218,12 @@ class Package { } class Library extends ModelElement { - LibraryElement get _library => (element as LibraryElement); Library(LibraryElement element) : super(element, null); - List get exported => _library.exportedLibraries.map((lib) => new Library(lib)).toList(); + List get exported => + _library.exportedLibraries.map((lib) => new Library(lib)).toList(); List getVariables() { List elements = []; @@ -229,8 +232,8 @@ class Library extends ModelElement { elements.addAll(cu.topLevelVariables); } elements - ..removeWhere(isPrivate) - ..sort(elementCompare); + ..removeWhere(isPrivate) + ..sort(elementCompare); return elements.map((e) => new Variable(e, this)).toList(); } @@ -241,8 +244,8 @@ class Library extends ModelElement { elements.addAll(cu.accessors); } elements - ..removeWhere(isPrivate) - ..sort(elementCompare); + ..removeWhere(isPrivate) + ..sort(elementCompare); elements.removeWhere((e) => e.isSynthetic); return elements.map((e) => new Accessor(e, this)).toList(); } @@ -254,8 +257,8 @@ class Library extends ModelElement { elements.addAll(cu.functionTypeAliases); } elements - ..removeWhere(isPrivate) - ..sort(elementCompare); + ..removeWhere(isPrivate) + ..sort(elementCompare); return elements.map((e) => new Typedef(e, this)).toList(); } @@ -266,8 +269,8 @@ class Library extends ModelElement { elements.addAll(cu.functions); } elements - ..removeWhere(isPrivate) - ..sort(elementCompare); + ..removeWhere(isPrivate) + ..sort(elementCompare); return elements.map((e) => new ModelFunction(e, this)).toList(); } @@ -278,14 +281,13 @@ class Library extends ModelElement { types.addAll(cu.types); } types - ..removeWhere(isPrivate) - ..sort(elementCompare); - return types.map((e) => new Class(e, this)).toList(); + ..removeWhere(isPrivate) + ..sort(elementCompare); + return types.map((e) => new Class(e, this)).toList(); } } class Class extends ModelElement { - ClassElement get _cls => (element as ClassElement); String get typeName => 'Classes'; @@ -294,44 +296,49 @@ class Class extends ModelElement { bool get isAbstract => _cls.isAbstract; - bool get hasSupertype => _cls.supertype != null && _cls.supertype.element.supertype != null; + bool get hasSupertype => + _cls.supertype != null && _cls.supertype.element.supertype != null; ElementType get supertype => new ElementType(_cls.supertype, library); - List get mixins => _cls.mixins.map((f) => new ElementType(f, library)).toList(); + List get mixins => + _cls.mixins.map((f) => new ElementType(f, library)).toList(); - List get interfaces => _cls.interfaces.map((f) => new ElementType(f, library)).toList(); + List get interfaces => + _cls.interfaces.map((f) => new ElementType(f, library)).toList(); List _getAllfields() { List elements = _cls.fields.toList() - ..removeWhere(isPrivate) - ..sort(elementCompare); + ..removeWhere(isPrivate) + ..sort(elementCompare); return elements.map((e) => new Field(e, library)).toList(); } - List getStaticFields() => _getAllfields()..removeWhere((f) => !f.isStatic); + List getStaticFields() => + _getAllfields()..removeWhere((f) => !f.isStatic); - List getInstanceFields() => _getAllfields()..removeWhere((f) => f.isStatic); + List getInstanceFields() => + _getAllfields()..removeWhere((f) => f.isStatic); List getAccessors() { List accessors = _cls.accessors.toList() - ..removeWhere(isPrivate) - ..sort(elementCompare); + ..removeWhere(isPrivate) + ..sort(elementCompare); accessors.removeWhere((e) => e.isSynthetic); return accessors.map((e) => new Accessor(e, library)).toList(); } List getCtors() { List c = _cls.constructors.toList() - ..removeWhere(isPrivate) - ..sort(elementCompare); + ..removeWhere(isPrivate) + ..sort(elementCompare); return c.map((e) => new Constructor(e, library)).toList(); } List getMethods() { List m = _cls.methods.toList() - ..removeWhere(isPrivate) - ..sort(elementCompare); + ..removeWhere(isPrivate) + ..sort(elementCompare); return m.map((e) => new Method(e, library)).toList(); } @@ -341,19 +348,20 @@ class Class extends ModelElement { } class ModelFunction extends ModelElement { - - ModelFunction(FunctionElement element, Library library) : super(element, library); + ModelFunction(FunctionElement element, Library library) + : super(element, library); FunctionElement get _func => (element as FunctionElement); String get typeName => 'Functions'; String createLinkedSummary(Helper generator) { - String retType = generator.createLinkedReturnTypeName(new ElementType(_func.type, library)); + String retType = generator.createLinkedReturnTypeName( + new ElementType(_func.type, library)); return '${generator.createLinkedName(this)}' - '(${generator.printParams(_func.parameters.map((f) => new Parameter(f, library)))})' - '${retType.isEmpty ? '' : ': $retType'}'; + '(${generator.printParams(_func.parameters.map((f) => new Parameter(f, library)))})' + '${retType.isEmpty ? '' : ': $retType'}'; } String createLinkedDescription(Helper generator) { @@ -361,17 +369,20 @@ class ModelFunction extends ModelElement { if (_func.isStatic) { buf.write('static '); } - buf.write(generator.createLinkedReturnTypeName(new ElementType(_func.type, library))); - buf.write(' ${_func.name}(${generator.printParams(_func.parameters.map((f) => new Parameter(f, library)).toList())})'); + buf.write(generator.createLinkedReturnTypeName( + new ElementType(_func.type, library))); + buf.write( + ' ${_func.name}(${generator.printParams(_func.parameters.map((f) => new Parameter(f, library)).toList())})'); return buf.toString(); } } class Typedef extends ModelElement { + FunctionTypeAliasElement get _typedef => + (element as FunctionTypeAliasElement); - FunctionTypeAliasElement get _typedef => (element as FunctionTypeAliasElement); - - Typedef(FunctionTypeAliasElement element, Library library) : super(element, library); + Typedef(FunctionTypeAliasElement element, Library library) + : super(element, library); String get typeName => 'Typedefs'; @@ -389,8 +400,10 @@ class Typedef extends ModelElement { } buf.write('>'); } - buf.write('(${generator.printParams(_typedef.parameters.map((f) => new Parameter(f, library)).toList())}): '); - buf.write(generator.createLinkedReturnTypeName(new ElementType(_typedef.type, library))); + buf.write( + '(${generator.printParams(_typedef.parameters.map((f) => new Parameter(f, library)).toList())}): '); + buf.write(generator.createLinkedReturnTypeName( + new ElementType(_typedef.type, library))); return buf.toString(); } @@ -398,7 +411,8 @@ class Typedef extends ModelElement { // typedef int Comparator(T a, T b) StringBuffer buf = new StringBuffer(); - buf.write('typedef ${generator.createLinkedReturnTypeName(new ElementType(_typedef.type, library))} ${_typedef.name}'); + buf.write( + 'typedef ${generator.createLinkedReturnTypeName(new ElementType(_typedef.type, library))} ${_typedef.name}'); if (!_typedef.typeParameters.isEmpty) { buf.write('<'); for (int i = 0; i < _typedef.typeParameters.length; i++) { @@ -409,14 +423,13 @@ class Typedef extends ModelElement { } buf.write('>'); } - buf.write('(${generator.printParams(_typedef.parameters.map((f) => new Parameter(f, library)).toList())}): '); + buf.write( + '(${generator.printParams(_typedef.parameters.map((f) => new Parameter(f, library)).toList())}): '); return buf.toString(); } - } class Field extends ModelElement { - FieldElement get _field => (element as FieldElement); Field(FieldElement element, Library library) : super(element, library); @@ -429,10 +442,10 @@ class Field extends ModelElement { } class Constructor extends ModelElement { - ConstructorElement get _constructor => (element as ConstructorElement); - Constructor(ConstructorElement element, Library library) : super(element, library); + Constructor(ConstructorElement element, Library library) + : super(element, library); String get typeName => 'Constructors'; @@ -448,9 +461,10 @@ class Constructor extends ModelElement { if (_constructor.isFactory) { buf.write('factory '); } - buf.write('${_constructor.type.returnType.name}${_constructor.name.isEmpty?'':'.'}' - '${_constructor.name}' - '(${generator.printParams( + buf.write( + '${_constructor.type.returnType.name}${_constructor.name.isEmpty?'':'.'}' + '${_constructor.name}' + '(${generator.printParams( _constructor.parameters.map((f) => new Parameter(f, library)).toList())})'); return buf.toString(); } @@ -475,10 +489,10 @@ class Method extends ModelElement { } class Accessor extends ModelElement { - PropertyAccessorElement get _accessor => (element as PropertyAccessorElement); - Accessor(PropertyAccessorElement element, Library library) : super(element, library); + Accessor(PropertyAccessorElement element, Library library) + : super(element, library); String get typeName => 'Getters and Setters'; @@ -490,12 +504,12 @@ class Accessor extends ModelElement { if (_accessor.isGetter) { buf.write(generator.createLinkedName(this)); buf.write(': '); - buf.write(generator.createLinkedReturnTypeName( - new ElementType(_accessor.type, - new ModelElement.from(_accessor.type.element, library)))); + buf.write(generator.createLinkedReturnTypeName(new ElementType( + _accessor.type, new ModelElement.from( + _accessor.type.element, library)))); } else { buf.write('${generator.createLinkedName(this)}(' - '${generator.printParams(_accessor.parameters.map((f) => + '${generator.printParams(_accessor.parameters.map((f) => new Parameter(f,library)))})'); } return buf.toString(); @@ -507,20 +521,21 @@ class Accessor extends ModelElement { buf.write('static '); } if (_accessor.isGetter) { - buf.write('${generator.createLinkedReturnTypeName(new ElementType(_accessor.type, new ModelElement.from(_accessor.type.element, library)))} get ${_accessor.name}'); + buf.write( + '${generator.createLinkedReturnTypeName(new ElementType(_accessor.type, new ModelElement.from(_accessor.type.element, library)))} get ${_accessor.name}'); } else { - buf.write('set ${_accessor.name}(${generator.printParams(_accessor.parameters.map((f) => new Parameter(f,library)))})'); + buf.write( + 'set ${_accessor.name}(${generator.printParams(_accessor.parameters.map((f) => new Parameter(f,library)))})'); } return buf.toString(); } - } class Variable extends ModelElement { - TopLevelVariableElement get _variable => (element as TopLevelVariableElement); - Variable(TopLevelVariableElement element, Library library) : super(element, library); + Variable(TopLevelVariableElement element, Library library) + : super(element, library); String get typeName => 'Top-Level Variables'; @@ -530,8 +545,8 @@ class Variable extends ModelElement { } class Parameter extends ModelElement { - - Parameter(ParameterElement element, Library library) : super(element, library); + Parameter(ParameterElement element, Library library) + : super(element, library); ParameterElement get _parameter => element as ParameterElement; @@ -556,7 +571,8 @@ class ElementType { String get returnTypeName => (_type as FunctionType).returnType.name; - ElementType get returnType => new ElementType((_type as FunctionType).returnType, library); + ElementType get returnType => + new ElementType((_type as FunctionType).returnType, library); ModelElement get returnElement { Element e = (_type as FunctionType).returnType.element; @@ -565,7 +581,10 @@ class ElementType { } return (new ModelElement.from(e, element.library)); } - List get typeArguments => (_type as ParameterizedType).typeArguments.map((f) => new ElementType(f, library)).toList(); + List get typeArguments => + (_type as ParameterizedType).typeArguments + .map((f) => new ElementType(f, library)) + .toList(); } abstract class Helper { diff --git a/lib/src/package_utils.dart b/lib/src/package_utils.dart index cb01b53b4e..adf5491d4b 100644 --- a/lib/src/package_utils.dart +++ b/lib/src/package_utils.dart @@ -9,7 +9,7 @@ import 'dart:io'; import 'package:path/path.dart' as path; import 'package:yaml/yaml.dart'; -String getPackageName(String directoryName) => +String getPackageName(String directoryName) => _getPubspec(directoryName)['name']; Map _getPubspec(String directoryName) { @@ -21,7 +21,7 @@ Map _getPubspec(String directoryName) { } String getPackageDescription(String directoryName) => - _getPubspec(directoryName)['description']; + _getPubspec(directoryName)['description']; String getPackageVersion(String directoryName) => - _getPubspec(directoryName)['version']; + _getPubspec(directoryName)['version']; diff --git a/test/template_test.dart b/test/template_test.dart index 729583bb90..b03974fc1f 100644 --- a/test/template_test.dart +++ b/test/template_test.dart @@ -12,7 +12,8 @@ import 'package:unittest/unittest.dart'; tests() { group('template', () { var script = new File(Platform.script.toFilePath()); - File tmplFile = new File('${script.parent.parent.path}/templates/sitemap.xml'); + File tmplFile = new File( + '${script.parent.parent.path}/templates/sitemap.xml'); test('sitemap template exists', () { tmplFile.exists().then((t) => expect(t, true)); @@ -22,8 +23,7 @@ tests() { var sitemap = compile(siteMapTmpl); test('render', () { - expect(sitemap({'links' : [{'name': 'somefile.html'}]}), - ''' + expect(sitemap({'links': [{'name': 'somefile.html'}]}), ''' @@ -34,8 +34,9 @@ tests() { }); test('substitute multiple links', () { - expect(sitemap({'links' : [{'name': 'somefile.html'}, {'name': 'asecondfile.html'}]}), - ''' + expect(sitemap({ + 'links': [{'name': 'somefile.html'}, {'name': 'asecondfile.html'}] + }), ''' @@ -49,8 +50,10 @@ tests() { }); test('url and file name', () { - expect(sitemap({'url': 'http://mydoc.com','links' : [{'name': 'somefile.html'}]}), - ''' + expect(sitemap({ + 'url': 'http://mydoc.com', + 'links': [{'name': 'somefile.html'}] + }), ''' @@ -58,6 +61,6 @@ tests() { '''); - }); + }); }); }