Unexpected `.` in generated file names results in `buf` warning
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- tooling
Research direction
Reproduce the warning with the shown buf generate command, buf.gen.yaml template, and plugin v3.21.2 on Linux, then compare the generated path with direct protoc output. Trace the plugin output against the referenced plugin.proto generation specification; done means buf receives a relative filename without a leading "." component and no longer warns.
Written by the indexing model from the issue text.
Description
When using the plugin v3.21.2 through buf on Linux (Ubuntu), I'm getting the following warning:
Warning: Generated file name "./some/path/to/file/my_message_pb.js" does not conform to the Protobuf generation specification. Note that the file name must be relative, use "/" instead of "", and not use "." or ".." as part of the file name. Buf will continue without error here, but please raise an issue with the maintainer of the plugin and reference https://github.com/protocolbuffers/protobuf/blob/95e6c5b4746dd7474d540ce4fb375e3f79a086f8/src/google/protobuf/compiler/plugin.proto#L122
...which is rather self-explanatory. I suspect this might be because of the . at the beginning.
The buf command I was using is the following:
buf generate /path/to/protos --template buf.gen.yaml -o /output/location
(i.e. I used full path for both - input and output paths)
buf generation template is
version: v1
plugins:
- name: js
out: .
opt: import_style=commonjs
I tried changing out to not be . to no avail.
There are no warnings when plugin is used through protoc directly, but I think the buf is right that returned file path should not have . components.
- Dominant language
- JavaScript
- Stars
- 471
- Forks
- 92
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from protocolbuffers/protobuf-javascript
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
protocolbuffers/protobuf-javascript#248 · 1 comment · 13 reactions ·
-
question
Difficulty 3/5 1-2 days Newbie friendliness 45/100
protocolbuffers/protobuf-javascript#222 · 9 comments ·
-
enhancement port-fix triaged
Difficulty 4/5 3-5 days Newbie friendliness 35/100
protocolbuffers/protobuf-javascript#185 · 1 comment ·
-
enhancement port-fix triaged
Difficulty 4/5 3-5 days Newbie friendliness 35/100
protocolbuffers/protobuf-javascript#182 · 3 comments · 1 reaction ·
All issues in protocolbuffers/protobuf-javascript
Similar issues
-
Radix number block generates NaN after switching a negative or decimal number to binary, octal or hexPossibly taken @matthewalberto claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
mit-cml/appinventor-sources#4246 · 1 comment ·
Maintainers usually reply within 1 day
-
marketing
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
accessibility good first issue languages
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 2 days
-
bug help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100