linter: new rule for declare(strict_types)

.gitignore

@@ -6,3 +6,5 @@ src/cmd/stubs/phpstorm-stubs/
 y.output
 .idea
 vendor
+dev
+src/tests/golden/testdata/quickfix/*.fix

example/custom/custom_test.go

@@ -11,6 +11,7 @@ func TestAssignmentAsExpression(t *testing.T) {
 	addCheckers(test.Config())
 
 	test.AddFile(`<?php
+	declare(strict_types = 1);
 	// PHPDoc annotations are not required for NoVerify in simple cases.
 	function something() {
 		$a = "test";

src/ir/irutil/keyword.go

@@ -14,6 +14,8 @@ func Keywords(n ir.Node) []*token.Token {
 	switch n := n.(type) {
 	case *ir.FunctionStmt:
 		return []*token.Token{n.FunctionTkn}
+	case *ir.DeclareStmt:
+		return []*token.Token{n.DeclareTkn}
 	case *ir.DefaultStmt:
 		return []*token.Token{n.DefaultTkn}
 	case *ir.CaseStmt:

src/linter/block_linter.go

@@ -57,6 +57,9 @@ func (b *blockLinter) enterNode(n ir.Node) {
 	case *ir.ExpressionStmt:
 		b.checkStmtExpression(n)
 
+	case *ir.DeclareStmt:
+		b.checkDeclareStrictTypes(n)
+
 	case *ir.ConstFetchExpr:
 		b.checkConstFetch(n)
 
@@ -547,7 +550,6 @@ func (b *blockLinter) checkNew(e *ir.NewExpr) {
 
 func (b *blockLinter) checkStmtExpression(s *ir.ExpressionStmt) {
 	report := false
-
 	// All branches except default try to filter-out common
 	// cases to reduce the number of type solving performed.
 	if irutil.IsAssign(s.Expr) {
@@ -1533,3 +1535,32 @@ func (b *blockLinter) classParseState() *meta.ClassParseState {
 func (b *blockLinter) metaInfo() *meta.Info {
 	return b.walker.r.ctx.st.Info
 }
+
+func (b *blockLinter) checkDeclareStrictTypes(statement *ir.DeclareStmt) {
+	if b.walker.r.strictTypes {
+		return
+	}
+
+	for _, i := range statement.Consts {
+		node, ok := i.(*ir.ConstantStmt)
+		if !ok {
+			return
+		}
+
+		if node.ConstantName.Value != "strict_types" {
+			return
+		}
+
+		value, isNumber := node.Expr.(*ir.Lnumber)
+		if !isNumber {
+			return
+		}
+
+		if value.Value == "1" {
+			return
+		}
+
+		b.report(statement, LevelWarning, "notStrictTypes", "strict_types value is not 1")
+		b.walker.r.addQuickFix("notStrictTypes", b.quickfix.StrictTypes(value))
+	}
+}

src/linter/quickfix.go

@@ -34,6 +34,22 @@ func (g *QuickFixGenerator) Array(arr *ir.ArrayExpr) quickfix.TextEdit {
 	}
 }
 
+func (g *QuickFixGenerator) StrictTypes(lnumber *ir.Lnumber) quickfix.TextEdit {
+	return quickfix.TextEdit{
+		StartPos:    lnumber.Position.StartPos,
+		EndPos:      lnumber.Position.EndPos,
+		Replacement: "1",
+	}
+}
+
+func (g *QuickFixGenerator) CreateDeclareStrictTypes(root *ir.Root) quickfix.TextEdit {
+	return quickfix.TextEdit{
+		StartPos:    root.Position.StartPos,
+		EndPos:      root.Position.StartPos,
+		Replacement: "declare(strict_types = 1);\n",
+	}
+}
+
 func (g *QuickFixGenerator) NullForNotNullableProperty(prop *ir.PropertyStmt) quickfix.TextEdit {
 	from := prop.Position.StartPos
 	to := prop.Variable.Position.EndPos

src/linter/report.go

@@ -25,6 +25,24 @@ func addBuiltinCheckers(reg *CheckersRegistry) {
 			After:    `$s = strip_tags($s, '<br>')`,
 		},
 
+		{
+			Name:     "notStrictTypes",
+			Default:  true,
+			Quickfix: true,
+			Comment:  "Report strict_types value is not 1 in declare section.",
+			Before:   `declare(strict_types = 0);`,
+			After:    `declare(strict_types = 1);`,
+		},
+
+		{
+			Name:     "noDeclareSection",
+			Default:  true,
+			Quickfix: true,
+			Comment:  "Report declare(strict_types=1) has not been set.",
+			Before:   ` `,
+			After:    `declare(strict_types = 1);`,
+		},
+
 		{
 			Name:     "emptyStmt",
 			Default:  true,
@@ -1185,8 +1203,8 @@ func DiffReports(gitRepo string, diffArgs []string, changesList []git.Change, ch
 		}
 	}
 
-	old := reportListToMap(oldList)
-	new := reportListToMap(newList)
+	oldReportMap := reportListToMap(oldList)
+	newReportMap := reportListToMap(newList)
 	changes := gitChangesToMap(changesList)
 
 	var mu sync.Mutex
@@ -1196,7 +1214,7 @@ func DiffReports(gitRepo string, diffArgs []string, changesList []git.Change, ch
 
 	limitCh := make(chan struct{}, maxConcurrency)
 
-	for filename, list := range new {
+	for filename, list := range newReportMap {
 		wg.Add(1)
 		go func(filename string, list []*Report) {
 			limitCh <- struct{}{}
@@ -1212,7 +1230,7 @@ func DiffReports(gitRepo string, diffArgs []string, changesList []git.Change, ch
 				oldName = filename // full diff mode
 			}
 
-			reports, err := diffReportsList(gitRepo, ignoreCommits, diffArgs, filename, c, old[oldName], list)
+			reports, err := diffReportsList(gitRepo, ignoreCommits, diffArgs, filename, c, oldReportMap[oldName], list)
 			if err != nil {
 				mu.Lock()
 				resErr = err
@@ -1266,8 +1284,8 @@ func diffReportsList(gitRepo string, ignoreCommits map[string]struct{}, diffArgs
 		}
 	}
 
-	old, oldMaxLine := reportListToPerLineMap(oldList)
-	new, newMaxLine := reportListToPerLineMap(newList)
+	oldPerLineMap, oldMaxLine := reportListToPerLineMap(oldList)
+	newPerLineMap, newMaxLine := reportListToPerLineMap(newList)
 
 	var maxLine = oldMaxLine
 	if newMaxLine > maxLine {
@@ -1284,17 +1302,17 @@ func diffReportsList(gitRepo string, ignoreCommits map[string]struct{}, diffArgs
 		// just deletion
 		if ok && ch.new.HaveRange && ch.new.Range == 0 {
 			oldLine = ch.old.To
-			newLine-- // cancel the increment of newLine, because code was deleted, no new lines added
+			newLine-- // cancel the increment of newLine, because code was deleted, no newPerLineMap lines added
 			continue
 		}
 
-		res = maybeAppendReports(res, new, old, newLine, oldLine, blame, ignoreCommits)
+		res = maybeAppendReports(res, newPerLineMap, oldPerLineMap, newLine, oldLine, blame, ignoreCommits)
 
 		if ok {
 			oldLine = 0 // all changes and additions must be checked
 			for j := newLine + 1; j <= ch.new.To; j++ {
 				newLine = j
-				res = maybeAppendReports(res, new, old, newLine, oldLine, blame, ignoreCommits)
+				res = maybeAppendReports(res, newPerLineMap, oldPerLineMap, newLine, oldLine, blame, ignoreCommits)
 			}
 			oldLine = ch.old.To
 		}

src/linter/root.go

@@ -69,10 +69,12 @@ type rootWalker struct {
 	// name matches the pattern and @linter disable was encountered
 
 	// strictTypes is true if file contains `declare(strict_types=1)`.
-	strictTypes bool
-	strictMixed bool
+	strictTypes    bool
+	strictMixed    bool
+	declareSection bool
 
-	reports []*Report
+	reports  []*Report
+	quickfix *QuickFixGenerator
 
 	config *Config
 
@@ -141,7 +143,12 @@ func (d *rootWalker) EnterNode(n ir.Node) (res bool) {
 			}
 			if c.ConstantName.Value == "strict_types" {
 				v, ok := c.Expr.(*ir.Lnumber)
-				if ok && v.Value == "1" {
+				if !ok {
+					continue
+				}
+
+				d.declareSection = true
+				if v.Value == "1" {
 					d.strictTypes = true
 				}
 			}

src/linter/worker.go

@@ -315,6 +315,11 @@ func (w *Worker) analyzeFile(file *workspace.File, rootNode *ir.Root) (*rootWalk
 	}
 	walker.afterLeaveFile()
 
+	if !walker.declareSection {
+		walker.Report(rootNode, LevelWarning, "noDeclareSection", "Missed declare(strict_types=1) directive")
+		walker.addQuickFix("notStrictTypes", walker.quickfix.CreateDeclareStrictTypes(rootNode))
+	}
+
 	if len(walker.ctx.fixes) != 0 {
 		needApplyFixes := !file.AutoGenerated() || w.config.CheckAutoGenerated
 

src/tests/checkers/anon_class_test.go

@@ -8,6 +8,7 @@ import (
 
 func TestSimpleAnonClass(t *testing.T) {
 	linttest.SimpleNegativeTest(t, `<?php
+		declare(strict_types = 1);
 function f() {
   $a = new class {
     /** */
@@ -21,6 +22,7 @@ function f() {
 
 func TestAnonClassAsInterface(t *testing.T) {
 	linttest.SimpleNegativeTest(t, `<?php
+	declare(strict_types = 1);
 interface IFace {}
 
 function f(IFace $if) {}
@@ -32,6 +34,7 @@ f(new class implements IFace {});
 func TestAnonClassFromDocumentation(t *testing.T) {
 	test := linttest.NewSuite(t)
 	test.AddFile(`<?php
+	declare(strict_types = 1);
 class Outer {
   private $prop = 1;
   protected $prop2 = 2;
@@ -66,6 +69,7 @@ echo (new Outer)->func2()->func3();
 
 func TestAnonClassWithConstructor(t *testing.T) {
 	linttest.SimpleNegativeTest(t, `<?php
+	declare(strict_types = 1);
 function f() {
   $a = new class(100, "s") {
     /** */
@@ -84,6 +88,7 @@ function f() {
 
 func TestAnonClassWithExtends(t *testing.T) {
 	linttest.SimpleNegativeTest(t, `<?php
+	declare(strict_types = 1);
 class Boo {
   /** */
   public function b() {}
@@ -103,6 +108,7 @@ function f() {
 
 func TestAnonClassWithImplements(t *testing.T) {
 	linttest.SimpleNegativeTest(t, `<?php
+	declare(strict_types = 1);
 interface IBoo {
   /** */
   public function b() {}
@@ -121,6 +127,8 @@ function f() {
 
 func TestAnonClassWithSeveralImplements(t *testing.T) {
 	linttest.SimpleNegativeTest(t, `<?php
+	declare(strict_types = 1);
+
 interface IBoo {
   /** */
   public function b() {}

src/tests/checkers/arrow_functions_test.go

@@ -9,6 +9,7 @@ import (
 func TestArrowFunction(t *testing.T) {
 	test := linttest.NewSuite(t)
 	test.AddFile(`<?php
+	declare(strict_types = 1);
 class Boo {
   /** @return int */
   public function b() { }
@@ -94,6 +95,8 @@ func TestUnusedInArrowFunction(t *testing.T) {
 		`stubs/phpstorm-stubs/standard/standard_9.php`,
 	}
 	test.AddFile(`<?php
+	declare(strict_types = 1);
+
 function f() {
   $a1 = [];
   $a2 = [];