OLD | NEW |
1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file |
2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
4 | 4 |
5 library directory_validator; | 5 library directory_validator; |
6 | 6 |
7 import 'dart:async'; | 7 import 'dart:async'; |
8 | 8 |
9 import '../entrypoint.dart'; | 9 import '../entrypoint.dart'; |
10 import '../io.dart'; | 10 import '../io.dart'; |
11 import '../validator.dart'; | 11 import '../validator.dart'; |
12 | 12 |
13 /// A validator that validates a package's top-level directories. | 13 /// A validator that validates a package's top-level directories. |
14 class DirectoryValidator extends Validator { | 14 class DirectoryValidator extends Validator { |
15 DirectoryValidator(Entrypoint entrypoint) | 15 DirectoryValidator(Entrypoint entrypoint) |
16 : super(entrypoint); | 16 : super(entrypoint); |
17 | 17 |
18 static final _PLURAL_NAMES = ["tools", "tests", "docs", "examples"]; | 18 static final _PLURAL_NAMES = ["tools", "tests", "docs", "examples"]; |
19 | 19 |
20 Future validate() { | 20 Future validate() { |
21 return listDir(entrypoint.root.dir).then((dirs) { | 21 return listDir(entrypoint.root.dir).then((dirs) { |
22 return Futures.wait(dirs.mappedBy((dir) { | 22 return Future.wait(dirs.mappedBy((dir) { |
23 return dirExists(dir).then((exists) { | 23 return dirExists(dir).then((exists) { |
24 if (!exists) return; | 24 if (!exists) return; |
25 | 25 |
26 dir = basename(dir); | 26 dir = basename(dir); |
27 if (_PLURAL_NAMES.contains(dir)) { | 27 if (_PLURAL_NAMES.contains(dir)) { |
28 // Cut off the "s" | 28 // Cut off the "s" |
29 var singularName = dir.substring(0, dir.length - 1); | 29 var singularName = dir.substring(0, dir.length - 1); |
30 warnings.add('Rename the top-level "$dir" directory to ' | 30 warnings.add('Rename the top-level "$dir" directory to ' |
31 '"$singularName".\n' | 31 '"$singularName".\n' |
32 'The Pub layout convention is to use singular directory ' | 32 'The Pub layout convention is to use singular directory ' |
33 'names.\n' | 33 'names.\n' |
34 'Plural names won\'t be correctly identified by Pub and other ' | 34 'Plural names won\'t be correctly identified by Pub and other ' |
35 'tools.'); | 35 'tools.'); |
36 } | 36 } |
37 | 37 |
38 if (dir.contains(new RegExp(r"^samples?$"))) { | 38 if (dir.contains(new RegExp(r"^samples?$"))) { |
39 warnings.add('Rename the top-level "$dir" directory to "example".\n' | 39 warnings.add('Rename the top-level "$dir" directory to "example".\n' |
40 'This allows Pub to find your examples and create "packages" ' | 40 'This allows Pub to find your examples and create "packages" ' |
41 'directories for them.\n'); | 41 'directories for them.\n'); |
42 } | 42 } |
43 }); | 43 }); |
44 })); | 44 })); |
45 }); | 45 }); |
46 } | 46 } |
47 } | 47 } |
OLD | NEW |