import doc::commands::commands_main
redef class ToolContext
+
+ # nitpackage phase
+ var nitpackage_phase: Phase = new NitPackagePhase(self, null)
+
# --expand
var opt_expand = new OptionBool("Move singleton packages to their own directory", "--expand")
# --gen-makefile
var opt_gen_makefile = new OptionBool("Generate Makefile files", "--gen-makefile")
- # nitpackage phase
- var nitpackage_phase: Phase = new NitPackagePhase(self, null)
+ # --check-man
+ var opt_check_man = new OptionBool("Check manpages files", "--check-man")
+
+ # --gen-man
+ var opt_gen_man = new OptionBool("Generate manpages files", "--gen-man")
+
+ # --check-readme
+ var opt_check_readme = new OptionBool("Check README.md files", "--check-readme")
redef init do
super
option_context.add_option(opt_expand, opt_force)
option_context.add_option(opt_check_ini, opt_gen_ini)
option_context.add_option(opt_check_makefile, opt_gen_makefile)
+ option_context.add_option(opt_check_man, opt_gen_man)
+ option_context.add_option(opt_check_readme)
end
end
continue
end
+ # Check manpages
+ if toolcontext.opt_check_man.value then
+ mpackage.check_man(toolcontext, mainmodule)
+ continue
+ end
+
+ # Check README.md
+ if toolcontext.opt_check_readme.value then
+ mpackage.check_readme(toolcontext)
+ continue
+ end
+
# Expand packages
if toolcontext.opt_expand.value and not mpackage.is_expanded then
var path = mpackage.expand
end
end
end
+
+ # Create manpages
+ if toolcontext.opt_gen_man.value then
+ mpackage.gen_man(toolcontext, mainmodule)
+ end
end
end
"package.name", "package.desc", "package.tags", "package.license",
"package.maintainer", "package.more_contributors",
"upstream.browse", "upstream.git", "upstream.git.directory",
- "upstream.homepage", "upstream.issues"
+ "upstream.homepage", "upstream.issues", "upstream.apk", "upstream.tryit",
+ "source.exclude"
]
private fun check_ini(toolcontext: ToolContext) do
private fun check_makefile(toolcontext: ToolContext, mainmodule: MModule) do
var model = toolcontext.modelbuilder.model
var filter = new ModelFilter(accept_example = false, accept_test = false)
- var view = new ModelView(model, mainmodule, filter)
- var cmd_bin = new CmdMains(view, mentity = self)
+ var cmd_bin = new CmdMains(model, filter, mentity = self)
var res_bin = cmd_bin.init_command
if not res_bin isa CmdSuccess then return
private fun gen_makefile(model: Model, mainmodule: MModule): nullable String do
var filter = new ModelFilter(accept_example = false, accept_test = false)
- var view = new ModelView(model, mainmodule, filter)
var pkg_path = package_path.as(not null)
var makefile_path = makefile_path.as(not null)
var bins = new Array[String]
- var cmd_bin = new CmdMains(view, mentity = self)
+ var cmd_bin = new CmdMains(model, filter, mentity = self)
var res_bin = cmd_bin.init_command
if res_bin isa CmdSuccess then
for mmodule in cmd_bin.results.as(not null) do
make.render.write_to_file(makefile_path)
return makefile_path
end
+
+ # Manpages
+
+ # The path to `self` manpage files
+ private fun man_path: nullable String do
+ var path = package_path
+ if path == null then return null
+ if not is_expanded then return null
+ return path / "man"
+ end
+
+ # Does `self` have a manpage files?
+ private fun has_man: Bool do
+ var man_path = self.man_path
+ if man_path == null then return false
+ return man_path.file_exists
+ end
+
+ private fun check_man(toolcontext: ToolContext, mainmodule: MModule) do
+ var model = toolcontext.modelbuilder.model
+ var filter = new ModelFilter(accept_example = false, accept_test = false)
+ var cmd = new CmdMains(model, filter, mentity = self)
+ var res = cmd.init_command
+ if not res isa CmdSuccess then return
+
+ for mmodule in cmd.results.as(not null) do
+ if not mmodule isa MModule then continue
+ mmodule.check_man(toolcontext)
+ end
+ end
+
+ private fun gen_man(toolcontext: ToolContext, mainmodule: MModule) do
+ var model = toolcontext.modelbuilder.model
+ var filter = new ModelFilter(accept_example = false, accept_test = false)
+ var cmd = new CmdMains(model, filter, mentity = self)
+ var res = cmd.init_command
+ if not res isa CmdSuccess then return
+
+ var pkg_man = man_path.as(not null)
+ for mmodule in cmd.results.as(not null) do
+ if not mmodule isa MModule then continue
+ if not has_man then pkg_man.mkdir
+ mmodule.gen_man(toolcontext)
+ end
+ end
+
+ # README
+
+ private fun check_readme(toolcontext: ToolContext) do
+ if not has_readme then
+ toolcontext.error(location, "No `README.md` file for `{name}`")
+ return
+ end
+ end
end
redef class MModule
end
return null
end
+
+ private fun man_path: nullable String do
+ var mpackage = self.mpackage
+ if mpackage == null then return null
+ var path = mpackage.man_path
+ if path == null then return null
+ return path / "{name}.man"
+ end
+
+ # Does `self` have a manpage?
+ private fun has_man: Bool do
+ var man_path = self.man_path
+ if man_path == null then return false
+ return man_path.file_exists
+ end
+
+ private fun make_module(toolcontext: ToolContext): Bool do
+ var mpackage = self.mpackage
+ if mpackage == null then return false
+ if not mpackage.is_expanded then return false
+
+ var pkg_path = mpackage.package_path
+ if pkg_path == null then return false
+
+ var pr = new ProcessReader("sh", "-c", "cd {pkg_path} && make -Bs bin/{name}")
+ var out = pr.read_all.trim
+ pr.close
+ pr.wait
+ if pr.status > 0 then
+ toolcontext.error(location, "unable to compile `{name}`")
+ print out
+ return false
+ end
+ return true
+ end
+
+ private fun stub_man(toolcontext: ToolContext): nullable String do
+ if not make_module(toolcontext) then return null
+ var mpackage = self.mpackage
+ if mpackage == null then return null
+ if not mpackage.is_expanded then return null
+
+ var pkg_path = mpackage.package_path
+ if pkg_path == null then return null
+
+ var pr = new ProcessReader("{pkg_path}/bin/{name}", "--stub-man")
+ var man = pr.read_all.trim
+ pr.close
+ pr.wait
+ if pr.status > 0 then
+ toolcontext.error(location, "unable to run `{pkg_path}/bin/{name} --stub-man`")
+ print man
+ return null
+ end
+ return man
+ end
+
+ private fun check_man(toolcontext: ToolContext) do
+ if not has_man then
+ toolcontext.error(location, "No manpage for bin {full_name}")
+ return
+ end
+ var man_path = self.man_path.as(not null)
+ var man = stub_man(toolcontext)
+ if man == null or man.is_empty then return
+
+ var old_man = new ManPage.from_file(self, man_path)
+ var new_man = new ManPage.from_string(self, man)
+ old_man.diff(toolcontext, new_man)
+ end
+
+ private fun gen_man(toolcontext: ToolContext) do
+ var man = stub_man(toolcontext)
+ if man == null or man.is_empty then return
+ var man_path = self.man_path
+ if man_path == null then return
+ man.write_to_file(man_path)
+ toolcontext.info("created manpage `{man_path}`", 0)
+ end
end
redef class ConfigTree
end
end
+private class ManPage
+ var mmodule: MModule
+ var name: nullable String is noinit
+ var synopsis: nullable String is noinit
+ var options = new HashMap[Array[String], String]
+
+ init from_file(mmodule: MModule, file: String) do
+ from_lines(mmodule, file.to_path.read_lines)
+ end
+
+ init from_string(mmodule: MModule, string: String) do
+ from_lines(mmodule, string.split("\n"))
+ end
+
+ init from_lines(mmodule: MModule, lines: Array[String]) do
+ init mmodule
+
+ var section = null
+ for i in [0..lines.length[ do
+ var line = lines[i]
+ if line.is_empty then continue
+
+ if line == "# NAME" then
+ section = "name"
+ continue
+ end
+ if line == "# SYNOPSIS" then
+ section = "synopsis"
+ continue
+ end
+ if line == "# OPTIONS" then
+ section = "options"
+ continue
+ end
+
+ if section == "name" and name == null then
+ name = line.trim
+ end
+ if section == "synopsis" and synopsis == null then
+ synopsis = line.trim
+ end
+ if section == "options" and line.has_prefix("###") then
+ var opts = new Array[String]
+ for opt in line.substring(3, line.length).trim.replace("`", "").split(",") do
+ opts.add opt.trim
+ end
+ var desc = ""
+ if i < lines.length - 1 then
+ desc = lines[i + 1].trim
+ end
+ options[opts] = desc
+ end
+ end
+ end
+
+ fun diff(toolcontext: ToolContext, ref: ManPage) do
+ if name != ref.name then
+ toolcontext.warning(mmodule.location, "diff-man",
+ "Warning: outdated man description. " +
+ "Expected `{ref.name or else ""}` got `{name or else ""}`.")
+ end
+ if synopsis != ref.synopsis then
+ toolcontext.warning(mmodule.location, "diff-man",
+ "Warning: outdated man synopsis. " +
+ "Expected `{ref.synopsis or else ""}` got `{synopsis or else ""}`.")
+ end
+ for name, desc in options do
+ if not ref.options.has_key(name) then
+ toolcontext.warning(mmodule.location, "diff-man",
+ "Warning: unknown man option `{name}`.`")
+ continue
+ end
+ var ref_desc = ref.options[name]
+ if desc != ref_desc then
+ toolcontext.warning(mmodule.location, "diff-man",
+ "Warning: outdated man option description. Expected `{ref_desc}` got `{desc}`.")
+ end
+ end
+ for ref_name, ref_desc in ref.options do
+ if not options.has_key(ref_name) then
+ toolcontext.warning(mmodule.location, "diff-man",
+ "Warning: missing man option `{ref_name}`.`")
+ end
+ end
+ end
+
+ redef fun to_s do
+ var tpl = new Template
+ tpl.addn "# NAME"
+ tpl.addn name or else ""
+ tpl.addn "# SYNOPSIS"
+ tpl.addn synopsis or else ""
+ tpl.addn "# OPTIONS"
+ for name, desc in options do
+ tpl.addn " * {name}: {desc}"
+ end
+ return tpl.write_to_string
+ end
+end
+
# build toolcontext
var toolcontext = new ToolContext
var tpl = new Template
nitlanguage / nit.git / blobdiff