typegap 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +11 -0
- data/LICENSE +21 -0
- data/README.ja.md +65 -0
- data/README.md +93 -0
- data/exe/typegap +6 -0
- data/lib/typegap/cli.rb +70 -0
- data/lib/typegap/finding.rb +38 -0
- data/lib/typegap/project.rb +80 -0
- data/lib/typegap/rules.rb +56 -0
- data/lib/typegap/signature_check.rb +166 -0
- data/lib/typegap/source_check.rb +730 -0
- data/lib/typegap/type_facts.rb +99 -0
- data/lib/typegap/version.rb +6 -0
- data/lib/typegap.rb +39 -0
- data/sig/generated/typegap/cli.rbs +30 -0
- data/sig/generated/typegap/finding.rbs +35 -0
- data/sig/generated/typegap/project.rbs +41 -0
- data/sig/generated/typegap/rules.rbs +36 -0
- data/sig/generated/typegap/signature_check.rbs +60 -0
- data/sig/generated/typegap/source_check.rbs +300 -0
- data/sig/generated/typegap/type_facts.rbs +60 -0
- data/sig/generated/typegap/version.rbs +5 -0
- data/sig/generated/typegap.rbs +14 -0
- metadata +86 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Generated from lib/typegap/type_facts.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
module Typegap
|
|
4
|
+
# What a Steep type says about nil, false, and classes. Every predicate
|
|
5
|
+
# answers only for a type Steep knows completely: untyped, a type variable,
|
|
6
|
+
# self, or an alias Steep did not expand says nothing, so a rule built on
|
|
7
|
+
# these stays silent there instead of guessing.
|
|
8
|
+
module TypeFacts
|
|
9
|
+
# @rbs type: untyped
|
|
10
|
+
# : (untyped) -> Array[untyped]
|
|
11
|
+
def self?.members: (untyped) -> Array[untyped]
|
|
12
|
+
|
|
13
|
+
# @rbs type: untyped
|
|
14
|
+
# : (untyped) -> String?
|
|
15
|
+
def self?.instance_name: (untyped) -> String?
|
|
16
|
+
|
|
17
|
+
# The class name of a member, with nil as NilClass and a literal as its class.
|
|
18
|
+
# @rbs type: untyped
|
|
19
|
+
# : (untyped) -> String?
|
|
20
|
+
def self?.class_name: (untyped) -> String?
|
|
21
|
+
|
|
22
|
+
# @rbs type: untyped
|
|
23
|
+
# : (untyped) -> bool
|
|
24
|
+
def self?.nil_type?: (untyped) -> bool
|
|
25
|
+
|
|
26
|
+
# @rbs type: untyped
|
|
27
|
+
# : (untyped) -> bool
|
|
28
|
+
def self?.bool_type?: (untyped) -> bool
|
|
29
|
+
|
|
30
|
+
# @rbs type: untyped
|
|
31
|
+
# : (untyped) -> bool
|
|
32
|
+
def self?.can_be_false?: (untyped) -> bool
|
|
33
|
+
|
|
34
|
+
# @rbs type: untyped
|
|
35
|
+
# : (untyped) -> bool
|
|
36
|
+
def self?.known?: (untyped) -> bool
|
|
37
|
+
|
|
38
|
+
# @rbs type: untyped
|
|
39
|
+
# : (untyped) -> bool
|
|
40
|
+
def self?.never_nil?: (untyped) -> bool
|
|
41
|
+
|
|
42
|
+
# @rbs type: untyped
|
|
43
|
+
# : (untyped) -> bool
|
|
44
|
+
def self?.never_falsy?: (untyped) -> bool
|
|
45
|
+
|
|
46
|
+
# @rbs type: untyped
|
|
47
|
+
# : (untyped) -> bool
|
|
48
|
+
def self?.nilable?: (untyped) -> bool
|
|
49
|
+
|
|
50
|
+
# A union of literals such as `:open | :closed`, possibly with nil.
|
|
51
|
+
# @rbs type: untyped
|
|
52
|
+
# : (untyped) -> bool
|
|
53
|
+
def self?.literal_union?: (untyped) -> bool
|
|
54
|
+
|
|
55
|
+
# @rbs type: untyped
|
|
56
|
+
# @rbs value: untyped
|
|
57
|
+
# : (untyped, untyped) -> bool
|
|
58
|
+
def self?.includes_literal?: (untyped, untyped) -> bool
|
|
59
|
+
end
|
|
60
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Generated from lib/typegap.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
# typegap reports where a Ruby project's RBS types and its code disagree, on
|
|
4
|
+
# the typing Steep infers. It ports the type-aware rules of typescript-eslint.
|
|
5
|
+
module Typegap
|
|
6
|
+
# Every finding in a project, sorted by place. `paths` limits the Ruby files
|
|
7
|
+
# read; signature files are read only when no path is given.
|
|
8
|
+
#
|
|
9
|
+
# @rbs root: String
|
|
10
|
+
# @rbs paths: Array[String]
|
|
11
|
+
# @rbs rules: Array[String]
|
|
12
|
+
# : (root: String, ?paths: Array[String], ?rules: Array[String]) -> Array[Finding]
|
|
13
|
+
def self.run: (root: String, ?paths: Array[String], ?rules: Array[String]) -> Array[Finding]
|
|
14
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: typegap
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- meganemura
|
|
8
|
+
bindir: exe
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: steep
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - ">="
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: 2.1.0
|
|
19
|
+
- - "<"
|
|
20
|
+
- !ruby/object:Gem::Version
|
|
21
|
+
version: '2.2'
|
|
22
|
+
type: :runtime
|
|
23
|
+
prerelease: false
|
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
25
|
+
requirements:
|
|
26
|
+
- - ">="
|
|
27
|
+
- !ruby/object:Gem::Version
|
|
28
|
+
version: 2.1.0
|
|
29
|
+
- - "<"
|
|
30
|
+
- !ruby/object:Gem::Version
|
|
31
|
+
version: '2.2'
|
|
32
|
+
executables:
|
|
33
|
+
- typegap
|
|
34
|
+
extensions: []
|
|
35
|
+
extra_rdoc_files: []
|
|
36
|
+
files:
|
|
37
|
+
- CHANGELOG.md
|
|
38
|
+
- LICENSE
|
|
39
|
+
- README.ja.md
|
|
40
|
+
- README.md
|
|
41
|
+
- exe/typegap
|
|
42
|
+
- lib/typegap.rb
|
|
43
|
+
- lib/typegap/cli.rb
|
|
44
|
+
- lib/typegap/finding.rb
|
|
45
|
+
- lib/typegap/project.rb
|
|
46
|
+
- lib/typegap/rules.rb
|
|
47
|
+
- lib/typegap/signature_check.rb
|
|
48
|
+
- lib/typegap/source_check.rb
|
|
49
|
+
- lib/typegap/type_facts.rb
|
|
50
|
+
- lib/typegap/version.rb
|
|
51
|
+
- sig/generated/typegap.rbs
|
|
52
|
+
- sig/generated/typegap/cli.rbs
|
|
53
|
+
- sig/generated/typegap/finding.rbs
|
|
54
|
+
- sig/generated/typegap/project.rbs
|
|
55
|
+
- sig/generated/typegap/rules.rbs
|
|
56
|
+
- sig/generated/typegap/signature_check.rbs
|
|
57
|
+
- sig/generated/typegap/source_check.rbs
|
|
58
|
+
- sig/generated/typegap/type_facts.rbs
|
|
59
|
+
- sig/generated/typegap/version.rbs
|
|
60
|
+
homepage: https://github.com/meganemura/typegap
|
|
61
|
+
licenses:
|
|
62
|
+
- MIT
|
|
63
|
+
metadata:
|
|
64
|
+
source_code_uri: https://github.com/meganemura/typegap
|
|
65
|
+
changelog_uri: https://github.com/meganemura/typegap/blob/main/CHANGELOG.md
|
|
66
|
+
bug_tracker_uri: https://github.com/meganemura/typegap/issues
|
|
67
|
+
rubygems_mfa_required: 'true'
|
|
68
|
+
rdoc_options: []
|
|
69
|
+
require_paths:
|
|
70
|
+
- lib
|
|
71
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - ">="
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: 3.3.0
|
|
76
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
77
|
+
requirements:
|
|
78
|
+
- - ">="
|
|
79
|
+
- !ruby/object:Gem::Version
|
|
80
|
+
version: '0'
|
|
81
|
+
requirements: []
|
|
82
|
+
rubygems_version: 4.0.16
|
|
83
|
+
specification_version: 4
|
|
84
|
+
summary: Find where a Ruby project's RBS types and its code disagree, with typescript-eslint's
|
|
85
|
+
type-aware rules on Steep.
|
|
86
|
+
test_files: []
|