// This file is part of the Luau programming language and is licensed under MIT License; see LICENSE.txt for details #include "Luau/ModuleResolver.h" #include "Luau/TypeInfer.h" #include "Luau/BuiltinDefinitions.h" #include "Luau/Frontend.h" #include "Luau/TypeAttach.h" #include "Luau/Transpiler.h" #include "FileUtils.h" LUAU_FASTFLAG(DebugLuauTimeTracing) LUAU_FASTFLAG(LuauTypeMismatchModuleNameResolution) enum class ReportFormat { Default, Luacheck, Gnu, }; static void report(ReportFormat format, const char* name, const Luau::Location& loc, const char* type, const char* message) { switch (format) { case ReportFormat::Default: fprintf(stderr, "%s(%d,%d): %s: %s\n", name, loc.begin.line + 1, loc.begin.column + 1, type, message); break; case ReportFormat::Luacheck: { // Note: luacheck's end column is inclusive but our end column is exclusive // In addition, luacheck doesn't support multi-line messages, so if the error is multiline we'll fake end column as 100 and hope for the best int columnEnd = (loc.begin.line == loc.end.line) ? loc.end.column : 100; // Use stdout to match luacheck behavior fprintf(stdout, "%s:%d:%d-%d: (W0) %s: %s\n", name, loc.begin.line + 1, loc.begin.column + 1, columnEnd, type, message); break; } case ReportFormat::Gnu: // Note: GNU end column is inclusive but our end column is exclusive fprintf(stderr, "%s:%d.%d-%d.%d: %s: %s\n", name, loc.begin.line + 1, loc.begin.column + 1, loc.end.line + 1, loc.end.column, type, message); break; } } static void reportError(const Luau::Frontend& frontend, ReportFormat format, const Luau::TypeError& error) { std::string humanReadableName = frontend.fileResolver->getHumanReadableModuleName(error.moduleName); if (const Luau::SyntaxError* syntaxError = Luau::get_if(&error.data)) report(format, humanReadableName.c_str(), error.location, "SyntaxError", syntaxError->message.c_str()); else if (FFlag::LuauTypeMismatchModuleNameResolution) report(format, humanReadableName.c_str(), error.location, "TypeError", Luau::toString(error, Luau::TypeErrorToStringOptions{frontend.fileResolver}).c_str()); else report(format, humanReadableName.c_str(), error.location, "TypeError", Luau::toString(error).c_str()); } static void reportWarning(ReportFormat format, const char* name, const Luau::LintWarning& warning) { report(format, name, warning.location, Luau::LintWarning::getName(warning.code), warning.text.c_str()); } static bool analyzeFile(Luau::Frontend& frontend, const char* name, ReportFormat format, bool annotate) { Luau::CheckResult cr; if (frontend.isDirty(name)) cr = frontend.check(name); if (!frontend.getSourceModule(name)) { fprintf(stderr, "Error opening %s\n", name); return false; } for (auto& error : cr.errors) reportError(frontend, format, error); Luau::LintResult lr = frontend.lint(name); std::string humanReadableName = frontend.fileResolver->getHumanReadableModuleName(name); for (auto& error : lr.errors) reportWarning(format, humanReadableName.c_str(), error); for (auto& warning : lr.warnings) reportWarning(format, humanReadableName.c_str(), warning); if (annotate) { Luau::SourceModule* sm = frontend.getSourceModule(name); Luau::ModulePtr m = frontend.moduleResolver.getModule(name); Luau::attachTypeData(*sm, *m); std::string annotated = Luau::transpileWithTypes(*sm->root); printf("%s", annotated.c_str()); } return cr.errors.empty() && lr.errors.empty(); } static void displayHelp(const char* argv0) { printf("Usage: %s [--mode] [options] [file list]\n", argv0); printf("\n"); printf("Available modes:\n"); printf(" omitted: typecheck and lint input files\n"); printf(" --annotate: typecheck input files and output source with type annotations\n"); printf("\n"); printf("Available options:\n"); printf(" --formatter=plain: report analysis errors in Luacheck-compatible format\n"); printf(" --formatter=gnu: report analysis errors in GNU-compatible format\n"); printf(" --timetrace: record compiler time tracing information into trace.json\n"); } static int assertionHandler(const char* expr, const char* file, int line, const char* function) { printf("%s(%d): ASSERTION FAILED: %s\n", file, line, expr); return 1; } struct CliFileResolver : Luau::FileResolver { std::optional readSource(const Luau::ModuleName& name) override { Luau::SourceCode::Type sourceType; std::optional source = std::nullopt; // If the module name is "-", then read source from stdin if (name == "-") { source = readStdin(); sourceType = Luau::SourceCode::Script; } else { source = readFile(name); sourceType = Luau::SourceCode::Module; } if (!source) return std::nullopt; return Luau::SourceCode{*source, sourceType}; } std::optional resolveModule(const Luau::ModuleInfo* context, Luau::AstExpr* node) override { if (Luau::AstExprConstantString* expr = node->as()) { Luau::ModuleName name = std::string(expr->value.data, expr->value.size) + ".luau"; if (!readFile(name)) { // fall back to .lua if a module with .luau doesn't exist name = std::string(expr->value.data, expr->value.size) + ".lua"; } return {{name}}; } return std::nullopt; } std::string getHumanReadableModuleName(const Luau::ModuleName& name) const override { if (name == "-") return "stdin"; return name; } }; struct CliConfigResolver : Luau::ConfigResolver { Luau::Config defaultConfig; mutable std::unordered_map configCache; mutable std::vector> configErrors; CliConfigResolver() { defaultConfig.mode = Luau::Mode::Nonstrict; } const Luau::Config& getConfig(const Luau::ModuleName& name) const override { std::optional path = getParentPath(name); if (!path) return defaultConfig; return readConfigRec(*path); } const Luau::Config& readConfigRec(const std::string& path) const { auto it = configCache.find(path); if (it != configCache.end()) return it->second; std::optional parent = getParentPath(path); Luau::Config result = parent ? readConfigRec(*parent) : defaultConfig; std::string configPath = joinPaths(path, Luau::kConfigName); if (std::optional contents = readFile(configPath)) { std::optional error = Luau::parseConfig(*contents, result); if (error) configErrors.push_back({configPath, *error}); } return configCache[path] = result; } }; int main(int argc, char** argv) { Luau::assertHandler() = assertionHandler; for (Luau::FValue* flag = Luau::FValue::list; flag; flag = flag->next) if (strncmp(flag->name, "Luau", 4) == 0) flag->value = true; if (argc >= 2 && strcmp(argv[1], "--help") == 0) { displayHelp(argv[0]); return 0; } ReportFormat format = ReportFormat::Default; bool annotate = false; for (int i = 1; i < argc; ++i) { if (argv[i][0] != '-') continue; if (strcmp(argv[i], "--formatter=plain") == 0) format = ReportFormat::Luacheck; else if (strcmp(argv[i], "--formatter=gnu") == 0) format = ReportFormat::Gnu; else if (strcmp(argv[i], "--annotate") == 0) annotate = true; else if (strcmp(argv[i], "--timetrace") == 0) FFlag::DebugLuauTimeTracing.value = true; } #if !defined(LUAU_ENABLE_TIME_TRACE) if (FFlag::DebugLuauTimeTracing) { printf("To run with --timetrace, Luau has to be built with LUAU_ENABLE_TIME_TRACE enabled\n"); return 1; } #endif Luau::FrontendOptions frontendOptions; frontendOptions.retainFullTypeGraphs = annotate; CliFileResolver fileResolver; CliConfigResolver configResolver; Luau::Frontend frontend(&fileResolver, &configResolver, frontendOptions); Luau::registerBuiltinTypes(frontend.typeChecker); Luau::freeze(frontend.typeChecker.globalTypes); std::vector files = getSourceFiles(argc, argv); int failed = 0; for (const std::string& path : files) failed += !analyzeFile(frontend, path.c_str(), format, annotate); if (!configResolver.configErrors.empty()) { failed += int(configResolver.configErrors.size()); for (const auto& pair : configResolver.configErrors) fprintf(stderr, "%s: %s\n", pair.first.c_str(), pair.second.c_str()); } if (format == ReportFormat::Luacheck) return 0; else return failed ? 1 : 0; }