Skip to content

Commit a1bebae

Browse files
elbrujohalconelbrujohalcon
authored
Merge pull request #71 from inaka/elbrujohalcon.70.modernize_this_project
Fixes #70: Modernize this project
2 parents b69d0e9 + ed927fb commit a1bebae

13 files changed

+801
-1146
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Bug Description
11+
A clear and concise description of what the bug is.
12+
13+
## To Reproduce
14+
Steps to reproduce the behavior
15+
16+
## Expected Behavior
17+
A clear and concise description of what you expected to happen.
18+
19+
## `rebar3` Logs
20+
If applicable, run `rebar3` with `DIAGNOSTIC=1` and attach all the logs to your report.
21+
22+
## Additional Context
23+
- OS: [e.g. MacOS]
24+
- Erlang version
25+
- rebar3 version

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Is your feature request related to a problem? Please describe.
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
## Describe the solution you'd like
14+
A clear and concise description of what you want to happen.
15+
16+
## Describe alternatives you've considered
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
## Additional Context
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/other-issues.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Other Issues
3+
about: Something that's not covered by the other categories
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Please consider opening a discussion if this is not really an issue -->

‎.github/workflows/ci.yml

+35-20
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,39 @@
1-
---
2-
name: build
3-
on:
4-
push:
5-
branches:
6-
- master
7-
pull_request:
8-
branches:
9-
- master
1+
name: Erlang CI
2+
3+
on: [push, pull_request]
4+
105
jobs:
11-
ci:
12-
name: Run checks and tests over ${{matrix.otp_vsn}} and ${{matrix.os}}
13-
runs-on: ${{matrix.os}}
6+
7+
build:
8+
9+
runs-on: ubuntu-latest
10+
1411
strategy:
1512
matrix:
16-
otp_vsn: [21, 22, 23, 24]
17-
os: [ubuntu-latest]
13+
otp: ['23.3', '24.3', '25.0']
14+
rebar: ['3.18.0']
15+
1816
steps:
19-
- uses: actions/checkout@v2
20-
- uses: erlef/setup-beam@v1
21-
with:
22-
otp-version: ${{matrix.otp_vsn}}
23-
rebar3-version: '3.14'
24-
- run: rebar3 test
17+
- uses: actions/checkout@v2
18+
- uses: erlef/setup-beam@v1
19+
id: setup-beam
20+
with:
21+
otp-version: ${{matrix.otp}}
22+
rebar3-version: ${{matrix.rebar}}
23+
- name: Restore _build
24+
uses: actions/cache@v2
25+
with:
26+
path: _build
27+
key: _build-cache-for-os-${{runner.os}}-otp-${{steps.setup-beam.outputs.otp-version}}-rebar3-${{steps.setup-beam.outputs.rebar3-version}}-hash-${{hashFiles('rebar.lock')}}
28+
- name: Restore rebar3's cache
29+
uses: actions/cache@v2
30+
with:
31+
path: ~/.cache/rebar3
32+
key: rebar3-cache-for-os-${{runner.os}}-otp-${{steps.setup-beam.outputs.otp-version}}-rebar3-${{steps.setup-beam.outputs.rebar3-version}}-hash-${{hashFiles('rebar.lock')}}
33+
- name: Compile
34+
run: ERL_FLAGS="-enable-feature all" rebar3 compile
35+
- name: Format check
36+
run: ERL_FLAGS="-enable-feature all" rebar3 format --verify
37+
- name: Run tests and verifications
38+
run: ERL_FLAGS="-enable-feature all" rebar3 test
39+

‎.gitignore

+7-13
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
1-
katana_code.d
2-
.erlang.mk/
1+
rebar3.crashdump
2+
.rebar3
3+
_*
34
.eunit
4-
deps
55
*.o
66
*.beam
77
*.plt
88
erl_crash.dump
9-
log
10-
logs
11-
bin
12-
ebin
13-
deps
14-
.erlang.mk.*
15-
hexer
16-
hexer.config
17-
doc
18-
_build
9+
rel/
10+
_build
11+
_checkouts
12+
doc/

‎CHANGELOG.md

+1-227
Original file line numberDiff line numberDiff line change
@@ -1,227 +1 @@
1-
# Changelog
2-
3-
## [1.2.0](https://github.com/inaka/katana-code/tree/1.2.0) (2021-09-18)
4-
5-
[Full Changelog](https://github.com/inaka/katana-code/compare/1.1.2...1.2.0)
6-
7-
**Merged pull requests:**
8-
9-
- Add pre\_fixer and post\_fixer options to the dodger [\#67](https://github.com/inaka/katana-code/pull/67) ([elbrujohalcon](https://github.com/elbrujohalcon))
10-
- Allow for analysis under rebar3\_hank [\#65](https://github.com/inaka/katana-code/pull/65) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
11-
- Increase consumer confidence [\#64](https://github.com/inaka/katana-code/pull/64) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
12-
- Move to a GitHub action \(instead of container-based\) CI approach [\#63](https://github.com/inaka/katana-code/pull/63) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
13-
14-
## [1.1.2](https://github.com/inaka/katana-code/tree/1.1.2) (2021-02-23)
15-
16-
[Full Changelog](https://github.com/inaka/katana-code/compare/1.1.1...1.1.2)
17-
18-
**Merged pull requests:**
19-
20-
- Remove discrepancies. Thanks, dialyzer! [\#62](https://github.com/inaka/katana-code/pull/62) ([elbrujohalcon](https://github.com/elbrujohalcon))
21-
22-
## [1.1.1](https://github.com/inaka/katana-code/tree/1.1.1) (2021-02-18)
23-
24-
[Full Changelog](https://github.com/inaka/katana-code/compare/1.1.0...1.1.1)
25-
26-
**Closed issues:**
27-
28-
- Parse non-module files [\#60](https://github.com/inaka/katana-code/issues/60)
29-
30-
**Merged pull requests:**
31-
32-
- Fix \#60: Handle parsing of none-module files [\#61](https://github.com/inaka/katana-code/pull/61) ([elbrujohalcon](https://github.com/elbrujohalcon))
33-
34-
## [1.1.0](https://github.com/inaka/katana-code/tree/1.1.0) (2021-02-02)
35-
36-
[Full Changelog](https://github.com/inaka/katana-code/compare/1.0.3...1.1.0)
37-
38-
**Closed issues:**
39-
40-
- Missing attribute definition elements for ktn\_code:type [\#53](https://github.com/inaka/katana-code/issues/53)
41-
- `ktn\_code:parse\_tree/1` issue while parsing for module attributes [\#43](https://github.com/inaka/katana-code/issues/43)
42-
43-
**Merged pull requests:**
44-
45-
- Compact strings directly when parsing, to preserve original formatting [\#59](https://github.com/inaka/katana-code/pull/59) ([elbrujohalcon](https://github.com/elbrujohalcon))
46-
- Fix broken CI [\#58](https://github.com/inaka/katana-code/pull/58) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
47-
- Add GitHub Actions for CI [\#57](https://github.com/inaka/katana-code/pull/57) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
48-
- Add some missing tree node types [\#56](https://github.com/inaka/katana-code/pull/56) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
49-
50-
## [1.0.3](https://github.com/inaka/katana-code/tree/1.0.3) (2020-11-25)
51-
52-
[Full Changelog](https://github.com/inaka/katana-code/compare/1.0.2...1.0.3)
53-
54-
**Merged pull requests:**
55-
56-
- Fix escript parsing [\#55](https://github.com/inaka/katana-code/pull/55) ([elbrujohalcon](https://github.com/elbrujohalcon))
57-
58-
## [1.0.2](https://github.com/inaka/katana-code/tree/1.0.2) (2020-11-25)
59-
60-
[Full Changelog](https://github.com/inaka/katana-code/compare/1.0.1...1.0.2)
61-
62-
**Fixed bugs:**
63-
64-
- Improve formatting in stringyfied macro definitions [\#52](https://github.com/inaka/katana-code/issues/52)
65-
66-
**Merged pull requests:**
67-
68-
- Be far more specific on how to stringify stuff [\#54](https://github.com/inaka/katana-code/pull/54) ([elbrujohalcon](https://github.com/elbrujohalcon))
69-
70-
## [1.0.1](https://github.com/inaka/katana-code/tree/1.0.1) (2020-11-19)
71-
72-
[Full Changelog](https://github.com/inaka/katana-code/compare/1.0.0...1.0.1)
73-
74-
**Fixed bugs:**
75-
76-
- Using macros in macro definitions breaks them [\#49](https://github.com/inaka/katana-code/issues/49)
77-
- Remove discrepancies [\#48](https://github.com/inaka/katana-code/issues/48)
78-
79-
**Merged pull requests:**
80-
81-
- \[Fix \#49\] Don't preprocess macros if we're not going to parse them later [\#51](https://github.com/inaka/katana-code/pull/51) ([elbrujohalcon](https://github.com/elbrujohalcon))
82-
- Fix \#48 by properly running dialyzer, xref and then linter [\#50](https://github.com/inaka/katana-code/pull/50) ([elbrujohalcon](https://github.com/elbrujohalcon))
83-
84-
## [1.0.0](https://github.com/inaka/katana-code/tree/1.0.0) (2020-11-19)
85-
86-
[Full Changelog](https://github.com/inaka/katana-code/compare/0.2.1...1.0.0)
87-
88-
**Fixed bugs:**
89-
90-
- ktn\_dodger can't parse stringifyied macro arguments [\#41](https://github.com/inaka/katana-code/issues/41)
91-
- ktn\_dodger can't parse macros in specs [\#38](https://github.com/inaka/katana-code/issues/38)
92-
- ktn\_dodger can't parse macros surrounded with parentheses [\#37](https://github.com/inaka/katana-code/issues/37)
93-
94-
**Closed issues:**
95-
96-
- Allow ktn\_dodger to parse escripts [\#42](https://github.com/inaka/katana-code/issues/42)
97-
- We need a way to retrieve macro text verbatim from ktn\_dodger [\#40](https://github.com/inaka/katana-code/issues/40)
98-
99-
**Merged pull requests:**
100-
101-
- Don't parse \(i.e. stringify\) macro definitions by default. [\#47](https://github.com/inaka/katana-code/pull/47) ([elbrujohalcon](https://github.com/elbrujohalcon))
102-
- \[Fix \#41\] Parse stringyfied macros [\#46](https://github.com/inaka/katana-code/pull/46) ([elbrujohalcon](https://github.com/elbrujohalcon))
103-
- Allow ktn\_dodger to parse escripts [\#45](https://github.com/inaka/katana-code/pull/45) ([elbrujohalcon](https://github.com/elbrujohalcon))
104-
- Prettify the stringification a bit [\#44](https://github.com/inaka/katana-code/pull/44) ([elbrujohalcon](https://github.com/elbrujohalcon))
105-
106-
## [0.2.1](https://github.com/inaka/katana-code/tree/0.2.1) (2019-12-03)
107-
108-
[Full Changelog](https://github.com/inaka/katana-code/compare/0.2.0...0.2.1)
109-
110-
**Merged pull requests:**
111-
112-
- Prepare release 0.2.1 [\#36](https://github.com/inaka/katana-code/pull/36) ([jfacorro](https://github.com/jfacorro))
113-
- \[\#26\] Remove aleppo from .app.src [\#35](https://github.com/inaka/katana-code/pull/35) ([jfacorro](https://github.com/jfacorro))
114-
115-
## [0.2.0](https://github.com/inaka/katana-code/tree/0.2.0) (2019-12-02)
116-
117-
[Full Changelog](https://github.com/inaka/katana-code/compare/0.1.3...0.2.0)
118-
119-
**Closed issues:**
120-
121-
- Published documentation on hexdocs.pm contains private functions [\#30](https://github.com/inaka/katana-code/issues/30)
122-
- ‘Ignored variable is being used’ reported for non-variables [\#26](https://github.com/inaka/katana-code/issues/26)
123-
124-
**Merged pull requests:**
125-
126-
- Bump version to 0.2.0 [\#33](https://github.com/inaka/katana-code/pull/33) ([elbrujohalcon](https://github.com/elbrujohalcon))
127-
- \[\#30\] Don't show private functions in documentation [\#32](https://github.com/inaka/katana-code/pull/32) ([juanbono](https://github.com/juanbono))
128-
- \[\#26\] Drop aleppo and use a forked epp\_dodger [\#31](https://github.com/inaka/katana-code/pull/31) ([jfacorro](https://github.com/jfacorro))
129-
130-
## [0.1.3](https://github.com/inaka/katana-code/tree/0.1.3) (2019-06-24)
131-
132-
[Full Changelog](https://github.com/inaka/katana-code/compare/0.1.2...0.1.3)
133-
134-
**Closed issues:**
135-
136-
- Unknown type `ktn\_code:tree\_node/0` [\#27](https://github.com/inaka/katana-code/issues/27)
137-
138-
**Merged pull requests:**
139-
140-
- Bump Version to 0.1.3 [\#29](https://github.com/inaka/katana-code/pull/29) ([elbrujohalcon](https://github.com/elbrujohalcon))
141-
- fix error with exporting types [\#28](https://github.com/inaka/katana-code/pull/28) ([NobbZ](https://github.com/NobbZ))
142-
143-
## [0.1.2](https://github.com/inaka/katana-code/tree/0.1.2) (2018-06-29)
144-
145-
[Full Changelog](https://github.com/inaka/katana-code/compare/0.1.0...0.1.2)
146-
147-
**Fixed bugs:**
148-
149-
- ktn\_code:type/1 returns 'var' for ?MODULE\_STRING [\#15](https://github.com/inaka/katana-code/issues/15)
150-
151-
**Closed issues:**
152-
153-
- Replace ktn\_xref\_SUITE by ktn\_meta\_SUITE [\#4](https://github.com/inaka/katana-code/issues/4)
154-
- Fulfill the open-source checklist [\#2](https://github.com/inaka/katana-code/issues/2)
155-
156-
**Merged pull requests:**
157-
158-
- Update deps and bump version to 0.1.2 [\#25](https://github.com/inaka/katana-code/pull/25) ([elbrujohalcon](https://github.com/elbrujohalcon))
159-
- Update Dependencies [\#24](https://github.com/inaka/katana-code/pull/24) ([elbrujohalcon](https://github.com/elbrujohalcon))
160-
- Bump Version to 0.1.1 [\#23](https://github.com/inaka/katana-code/pull/23) ([elbrujohalcon](https://github.com/elbrujohalcon))
161-
- Update aleppo to 1.0.1 [\#22](https://github.com/inaka/katana-code/pull/22) ([jfacorro](https://github.com/jfacorro))
162-
- Add API to provide file name for `parse\_tree` [\#21](https://github.com/inaka/katana-code/pull/21) ([seriyps](https://github.com/seriyps))
163-
- Remove dead hipchat link [\#20](https://github.com/inaka/katana-code/pull/20) ([elbrujohalcon](https://github.com/elbrujohalcon))
164-
165-
## [0.1.0](https://github.com/inaka/katana-code/tree/0.1.0) (2016-06-14)
166-
167-
[Full Changelog](https://github.com/inaka/katana-code/compare/0.0.4...0.1.0)
168-
169-
**Closed issues:**
170-
171-
- Version Bump to 0.1.0 [\#18](https://github.com/inaka/katana-code/issues/18)
172-
- Move from erlang.mk to rebar3 [\#16](https://github.com/inaka/katana-code/issues/16)
173-
- Version Bump 0.0.4 [\#13](https://github.com/inaka/katana-code/issues/13)
174-
175-
**Merged pull requests:**
176-
177-
- \[Close \#18\] version bump to 0.1.0 [\#19](https://github.com/inaka/katana-code/pull/19) ([Euen](https://github.com/Euen))
178-
- \[Close \#16\] rebar3 support [\#17](https://github.com/inaka/katana-code/pull/17) ([Euen](https://github.com/Euen))
179-
180-
## [0.0.4](https://github.com/inaka/katana-code/tree/0.0.4) (2016-04-26)
181-
182-
[Full Changelog](https://github.com/inaka/katana-code/compare/0.0.3...0.0.4)
183-
184-
**Merged pull requests:**
185-
186-
- \[\#13\] Version Bump 0.0.4 [\#14](https://github.com/inaka/katana-code/pull/14) ([davecaos](https://github.com/davecaos))
187-
- Add support for latin1 encoded source files [\#12](https://github.com/inaka/katana-code/pull/12) ([tjarvstrand](https://github.com/tjarvstrand))
188-
189-
## [0.0.3](https://github.com/inaka/katana-code/tree/0.0.3) (2016-04-07)
190-
191-
[Full Changelog](https://github.com/inaka/katana-code/compare/0.0.2...0.0.3)
192-
193-
**Fixed bugs:**
194-
195-
- Add deps to the app.src file [\#10](https://github.com/inaka/katana-code/pull/10) ([elbrujohalcon](https://github.com/elbrujohalcon))
196-
197-
**Merged pull requests:**
198-
199-
- Version Bump to 0.0.3 [\#11](https://github.com/inaka/katana-code/pull/11) ([elbrujohalcon](https://github.com/elbrujohalcon))
200-
201-
## [0.0.2](https://github.com/inaka/katana-code/tree/0.0.2) (2016-03-30)
202-
203-
[Full Changelog](https://github.com/inaka/katana-code/compare/0.0.1...0.0.2)
204-
205-
**Fixed bugs:**
206-
207-
- katana-code.app.src should be called katana\_code.app.src [\#6](https://github.com/inaka/katana-code/pull/6) ([elbrujohalcon](https://github.com/elbrujohalcon))
208-
209-
**Merged pull requests:**
210-
211-
- \[\#quick\] Add katana\_code.d to .gitignore [\#9](https://github.com/inaka/katana-code/pull/9) ([elbrujohalcon](https://github.com/elbrujohalcon))
212-
- \[\#quick\] Fix project name [\#8](https://github.com/inaka/katana-code/pull/8) ([elbrujohalcon](https://github.com/elbrujohalcon))
213-
- Version Bump to 0.0.2 [\#7](https://github.com/inaka/katana-code/pull/7) ([elbrujohalcon](https://github.com/elbrujohalcon))
214-
215-
## [0.0.1](https://github.com/inaka/katana-code/tree/0.0.1) (2016-03-01)
216-
217-
[Full Changelog](https://github.com/inaka/katana-code/compare/d4c5b63916ff692ff1fedc3f31787e4cedb70cf8...0.0.1)
218-
219-
**Merged pull requests:**
220-
221-
- Igaray.version bump [\#5](https://github.com/inaka/katana-code/pull/5) ([igaray](https://github.com/igaray))
222-
- Initial commit [\#3](https://github.com/inaka/katana-code/pull/3) ([igaray](https://github.com/igaray))
223-
- Update LICENSE [\#1](https://github.com/inaka/katana-code/pull/1) ([elbrujohalcon](https://github.com/elbrujohalcon))
224-
225-
226-
227-
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
1+
See the [Releases](../../releases) page.

0 commit comments

Comments
 (0)