rule

---

⚠️ We have a new website! Visit now for the most update to date documentation.
       This wiki is no longer being maintained.

---

Creates a new custom rule, and makes it the active configuration scope.

rule ("name")

Rules contain the settings and property definitions for a single custom rule file. These settings include the target file extension, the command line format, and the build inputs and outputs.

Parameters

name is the name for the rule, which must be unique for each rule specified. If a rule with the given name already exists, it is made active and returned.

If no name is given, the current rule scope is returned, and also made active.

By default, the rule name will be used as the file name of the generated rule files; be careful with spaces and special characters. You can override this default with filename() and location().

Availability

Premake 5.0 or later.

Examples

Create a new rule named "luac". For a more complete example, see Custom Rules.

rule "luac"
  fileExtension ".lua"

See Also

• Custom Rules
• externalrule
• propertydefinition
• rules