Function ParseCommentFlags

internal/metadata/meta.go:123–172

ParseCommentFlags processes the comments provided with queries to determine the metadata params, flags and rules to skip. All flags in query comments are prefixed with `@`, e.g. @param, @@sqlc-vet-disable.

(comments []string)

// ParseCommentFlags processes the comments provided with queries to determine the metadata params, flags and rules to skip.
// All flags in query comments are prefixed with `@`, e.g. @param, @@sqlc-vet-disable.
func ParseCommentFlags(comments []string) (map[string]string, map[string]bool, map[string]struct{}, error) {
	params := make(map[string]string)
	flags := make(map[string]bool)
	ruleSkiplist := make(map[string]struct{})

	for _, line := range comments {
		s := bufio.NewScanner(strings.NewReader(line))
		s.Split(bufio.ScanWords)

		s.Scan()
		token := s.Text()

		if !strings.HasPrefix(token, "@") {
			continue
		}

		switch token {
		case constants.QueryFlagParam:
			s.Scan()
			name := s.Text()
			var rest []string
			for s.Scan() {
				paramToken := s.Text()
				rest = append(rest, paramToken)
			}
			params[name] = strings.Join(rest, " ")

		case constants.QueryFlagSqlcVetDisable:
			flags[token] = true

			// Vet rules can all be disabled in the same line or split across lines .i.e.
			// /* @sqlc-vet-disable sqlc/db-prepare delete-without-where */
			// is equivalent to:
			// /* @sqlc-vet-disable sqlc/db-prepare */
			// /* @sqlc-vet-disable delete-without-where */
			for s.Scan() {
				ruleSkiplist[s.Text()] = struct{}{}
			}

		default:
			flags[token] = true
		}

		if s.Err() != nil {
			return params, flags, ruleSkiplist, s.Err()
		}
	}

	return params, flags, ruleSkiplist, nil
}