Match dir layout conventions of other dwtj rules

These are all internal changes except for `markdownlint_aspect`. It is now located in `@dwtj_rules_markdown//markdown:aspects.bzl`. Also removed lots of unnecessary subpackages `//markdown`. (That is, I deleted a bunch of empty `BUILD` files within `//markdown`.)
dwtj · Sep 2, 2020 · 483ea28 · 483ea28
1 parent 37dd25a
commit 483ea28
Show file tree

Hide file tree

Showing 26 changed files with 25 additions and 20 deletions.
diff --git a/.bazelrc b/.bazelrc
@@ -1 +1 @@
-build --aspects @dwtj_rules_markdown//markdown:defs.bzl%markdownlint_aspect
+build --aspects @dwtj_rules_markdown//markdown:aspects.bzl%markdownlint_aspect
diff --git a/markdown/aspects.bzl b/markdown/aspects.bzl
@@ -0,0 +1,6 @@
+'''This file exports public rule definitions for use by clients.
+'''
+
+load('//markdown:private/aspects/markdownlint_aspect/defs.bzl', _markdownlint_aspect = 'markdownlint_aspect')
+
+markdownlint_aspect = _markdownlint_aspect
diff --git a/markdown/aspects/markdownlint_aspect/BUILD b/markdown/aspects/markdownlint_aspect/BUILD
diff --git a/markdown/defs.bzl b/markdown/defs.bzl
@@ -1,10 +1,6 @@
 '''This file exports public rule definitions for use by clients.
 '''
 
-load('//markdown/rules/markdown_library:defs.bzl', _markdown_library = 'markdown_library')
-
-load('//markdown/aspects/markdownlint_aspect:defs.bzl', _markdownlint_aspect = 'markdownlint_aspect')
+load('//markdown:private/rules/markdown_library/defs.bzl', _markdown_library = 'markdown_library')
 
 markdown_library = _markdown_library
-
-markdownlint_aspect = _markdownlint_aspect
diff --git a/markdown/private/BUILD b/markdown/private/BUILD
diff --git a/...down/aspects/markdownlint_aspect/defs.bzl → ...vate/aspects/markdownlint_aspect/defs.bzl b/...down/aspects/markdownlint_aspect/defs.bzl → ...vate/aspects/markdownlint_aspect/defs.bzl
@@ -4,7 +4,7 @@ This aspect adds a lint as an action to `markdown` targets. The lint is
 performed by the lint tool provided by the selected `markdown_lint_toolchain`.
 '''
 
-load("@dwtj_rules_markdown//markdown/rules/markdown_library:defs.bzl", "MarkdownInfo")
+load("@dwtj_rules_markdown//markdown:private/rules/markdown_library/defs.bzl", "MarkdownInfo")
 
 MarkdownLintAspectInfo = provider(
     fields = {

diff --git a/markdown/private/constants.bzl → markdown/private/common/constants.bzl b/markdown/private/constants.bzl → markdown/private/common/constants.bzl
@@ -3,4 +3,6 @@ project's implementation. They shouldn't be directly used by any client of this
 project.
 '''
 
-SUPPORTED_MARKDOWNLINT_CONFIG_FILE_EXTENSIONS = ['.json']
+SUPPORTED_MARKDOWN_FILE_EXTENSIONS = ['.md', '.markdown']
+
+SUPPORTED_MARKDOWNLINT_CONFIG_FILE_EXTENSIONS = ['.json']
diff --git a/...al_markdownlint_repository/template.BUILD → ...al_markdownlint_repository/TEMPLATE.BUILD b/...al_markdownlint_repository/template.BUILD → ...al_markdownlint_repository/TEMPLATE.BUILD
diff --git a/...markdownlint_repository/template.defs.bzl → ...markdownlint_repository/TEMPLATE.defs.bzl b/...markdownlint_repository/template.defs.bzl → ...markdownlint_repository/TEMPLATE.defs.bzl
diff --git a/...nt/local_markdownlint_repository/defs.bzl → ...nt/local_markdownlint_repository/defs.bzl b/...nt/local_markdownlint_repository/defs.bzl → ...nt/local_markdownlint_repository/defs.bzl
@@ -3,10 +3,7 @@ symlink to a local `markdownlint` binary and some boilerplate to use it as part
 of a `markdownlint_toolchain` instance.
 """
 
-load(
-    '@dwtj_rules_markdown//markdown/private:constants.bzl',
-    'SUPPORTED_MARKDOWNLINT_CONFIG_FILE_EXTENSIONS'
-)
+load('@dwtj_rules_markdown//markdown:private/common/constants.bzl', 'SUPPORTED_MARKDOWNLINT_CONFIG_FILE_EXTENSIONS')
 
 # This is the name used for the config file *within* this external repository.
 _CONFIG_FILE = 'markdownlint_config.json'
@@ -98,11 +95,11 @@ local_markdownlint_repository = repository_rule(
         #  interpreted as paths relative to the external repository's root.
         '_build_file_template': attr.label(
             allow_single_file = True,
-            default = '@dwtj_rules_markdown//markdown/repository_rules/markdownlint/local_markdownlint_repository:template.BUILD',
+            default = '@dwtj_rules_markdown//markdown:private/repository_rules/markdownlint/local_markdownlint_repository/TEMPLATE.BUILD',
         ),
         '_defs_bzl_file_template': attr.label(
             allow_single_file = True,
-            default = '@dwtj_rules_markdown//markdown/repository_rules/markdownlint/local_markdownlint_repository:template.defs.bzl',
+            default = '@dwtj_rules_markdown//markdown:private/repository_rules/markdownlint/local_markdownlint_repository/TEMPLATE.defs.bzl',
         ),
     },
     environ = [

diff --git a/markdown/rules/markdown_library/defs.bzl → ...n/private/rules/markdown_library/defs.bzl b/markdown/rules/markdown_library/defs.bzl → ...n/private/rules/markdown_library/defs.bzl
@@ -1,7 +1,11 @@
 '''Defines the `markdown_library` Bazel rule.
 '''
 
-load('//markdown/private:constants.bzl', 'SUPPORTED_MARKDOWNLINT_CONFIG_FILE_EXTENSIONS')
+load(
+    '//markdown:private/common/constants.bzl',
+    'SUPPORTED_MARKDOWN_FILE_EXTENSIONS',
+    'SUPPORTED_MARKDOWNLINT_CONFIG_FILE_EXTENSIONS',
+)
 
 MarkdownInfo = provider(
     fields = [
@@ -32,12 +36,12 @@ markdown_library = rule(
     attrs = {
         'srcs': attr.label_list(
             allow_empty = False,
-            allow_files = ['.md', '.markdown'],
+            allow_files = SUPPORTED_MARKDOWN_FILE_EXTENSIONS,
             doc = 'A list of Markdown source files to be included.'
         ),
         'deps': attr.label_list(
             providers = [MarkdownInfo],
-            doc = 'A list of labels providing `MarkdownInfo`. Usually, this is a list of names of `markdown_library` instances.'
+            doc = 'A list of labels providing `MarkdownInfo` (e.g. `markdown_library` target labels).'
         ),
         'markdownlint_config': attr.label(
             default = None,

diff --git a/...own/rules/markdownlint_toolchain/defs.bzl → ...ate/rules/markdownlint_toolchain/defs.bzl b/...own/rules/markdownlint_toolchain/defs.bzl → ...ate/rules/markdownlint_toolchain/defs.bzl
@@ -4,7 +4,7 @@ Markdown lint toolchain instances are created by writing
 `markdownlint_toolchain` rule instances.
 '''
 
-load('//markdown/private:constants.bzl', 'SUPPORTED_MARKDOWNLINT_CONFIG_FILE_EXTENSIONS')
+load('//markdown:private/common/constants.bzl', 'SUPPORTED_MARKDOWNLINT_CONFIG_FILE_EXTENSIONS')
 
 MarkdownlintToolchainInfo = provider(
     fields = [

diff --git a/markdown/repositories.bzl b/markdown/repositories.bzl
@@ -1,6 +1,6 @@
 '''This file exports public repository rule definitions for use by clients.
 '''
 
-load('//markdown/repository_rules/markdownlint/local_markdownlint_repository:defs.bzl', _local_markdownlint_repository = 'local_markdownlint_repository')
+load('//markdown:private/repository_rules/markdownlint/local_markdownlint_repository/defs.bzl', _local_markdownlint_repository = 'local_markdownlint_repository')
 
 local_markdownlint_repository = _local_markdownlint_repository
diff --git a/markdown/repository_rules/BUILD b/markdown/repository_rules/BUILD
diff --git a/markdown/repository_rules/markdownlint/BUILD b/markdown/repository_rules/markdownlint/BUILD
diff --git a/markdown/repository_rules/markdownlint/local_markdownlint_repository/BUILD b/markdown/repository_rules/markdownlint/local_markdownlint_repository/BUILD
diff --git a/markdown/rules/BUILD b/markdown/rules/BUILD
diff --git a/markdown/rules/markdown_library/BUILD b/markdown/rules/markdown_library/BUILD
diff --git a/markdown/rules/markdownlint_toolchain/BUILD b/markdown/rules/markdownlint_toolchain/BUILD
diff --git a/markdown/toolchains.bzl b/markdown/toolchains.bzl
@@ -1,6 +1,6 @@
 '''This file exports public toolchain rule definitions for use by clients.
 '''
 
-load('//markdown/rules/markdownlint_toolchain:defs.bzl', _markdownlint_toolchain = 'markdownlint_toolchain')
+load('//markdown:private/rules/markdownlint_toolchain/defs.bzl', _markdownlint_toolchain = 'markdownlint_toolchain')
 
 markdownlint_toolchain = _markdownlint_toolchain
diff --git a/markdown/aspects/BUILD → test/BUILD b/markdown/aspects/BUILD → test/BUILD
diff --git a/tests/smoke_test/BUILD → test/smoke_test/BUILD b/tests/smoke_test/BUILD → test/smoke_test/BUILD
diff --git a/tests/smoke_test/a_good_markdown_file.md → test/smoke_test/a_good_markdown_file.md b/tests/smoke_test/a_good_markdown_file.md → test/smoke_test/a_good_markdown_file.md
diff --git a/...smoke_test/a_nonstandard_markdown_file.md → ...smoke_test/a_nonstandard_markdown_file.md b/...smoke_test/a_nonstandard_markdown_file.md → ...smoke_test/a_nonstandard_markdown_file.md
diff --git a/...st/a_nonstandard_markdownlint_config.json → ...st/a_nonstandard_markdownlint_config.json b/...st/a_nonstandard_markdownlint_config.json → ...st/a_nonstandard_markdownlint_config.json
diff --git a/tests/BUILD b/tests/BUILD
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		build --aspects @dwtj_rules_markdown//markdown:defs.bzl%markdownlint_aspect
		build --aspects @dwtj_rules_markdown//markdown:aspects.bzl%markdownlint_aspect