Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ensure nuspec files generated from the choco new command use UTF-8 without a byte order mark #1364

Closed
jnm2 opened this issue Jul 18, 2017 · 5 comments · Fixed by #2064
Closed

Ensure nuspec files generated from the choco new command use UTF-8 without a byte order mark #1364

jnm2 opened this issue Jul 18, 2017 · 5 comments · Fixed by #2064
Labels
5 - Released Improvement Priority_LOW
Milestone
0.11.0

Comments

@jnm2
Copy link

jnm2 commented Jul 18, 2017

I'm totally on board with this:

Do not save your *.nuspec files with a Byte Order Mark (BOM). A BOM is neither required nor recommended for UTF-8, because it can lead to several issues.

https://chocolatey.org/docs/create-packages#character-encoding

But choco new is not. It's currently creating UTF-8-BOM nuspecs.

Moved from https://github.com/chocolatey/chocolatey.org/issues/527
@ferventcoder ferventcoder added this to the 0.10.x milestone Aug 6, 2017
@ferventcoder
Copy link
Member

This one is open for up for grabs.

@Benny1007
Copy link

I would like to have a go if I may?

Benny1007 pushed a commit to Benny1007/choco that referenced this issue Sep 29, 2017
(chocolateyGH-1364) - Modification of template service to generate UT…
6c76c44 
…F8 files without BOM.
Benny1007 added a commit to Benny1007/choco that referenced this issue Sep 29, 2017
@Benny1007
(chocolateyGH-1364) - update template service to generate UTF8 files …
573f43d 
…without BOM.
This was referenced Sep 29, 2017
Open
Closed
@Benny1007
Copy link

anyone have time to show me where im going wrong?

@vexx32
Copy link
Member

vexx32 commented Jan 9, 2019

@Benny1007 are you still interested in this?

At a quick glance on your PR, the "changed" but untouched files mostly seem to be registering as changed due to something in your system stripping out the BOM from those files; I think that ought to be largely OK. 🙂

@bcurran3
Copy link

bcurran3 commented Sep 1, 2019 •
edited

I found a bunch of my nuspec files with BOM. I later made https://chocolatey.org/packages/choco-nuspec-checker to check and fix them automatically... and then got a little ADHD with it. :)

TheCakeIsNaOH added a commit to TheCakeIsNaOH/choco that referenced this issue Jun 8, 2020
@TheCakeIsNaOH
(chocolateyGH-1364) Template create .nuspec encoded without BOM
a18eaa5 
Changes the encoding of `.nuspec` files created from templates to UTF8 with BOM to UTF8 without BOM according to best practices in the creating packages documentation. Applies to both the default template and to custom templates.

Adjusted template services tests to include UTF8 no BOM files, otherwise nuspec files would not be detected anymore.
@TheCakeIsNaOH TheCakeIsNaOH mentioned this issue Jun 8, 2020
Merged
TheCakeIsNaOH added a commit to TheCakeIsNaOH/choco that referenced this issue Jun 17, 2020
@TheCakeIsNaOH
(chocolateyGH-1364) Template create .nuspec encoded without BOM
59ebafa 
Changes the encoding of `.nuspec` files created from templates to UTF8
with BOM to UTF8 without BOM according to best practices in the
creating packages documentation.

Applies to both the default template and to custom templates.

Adjusted template services tests to include UTF8 no BOM files,
otherwise nuspec files would not be detected anymore.
gep13 pushed a commit to TheCakeIsNaOH/choco that referenced this issue Apr 16, 2021
@TheCakeIsNaOH @gep13
(chocolateyGH-1364) Template create .nuspec encoded without BOM
21e8d77 
Changes the encoding of `.nuspec` files created from templates to UTF8
with BOM to UTF8 without BOM according to best practices in the
creating packages documentation.

Applies to both the default template and to custom templates.

Adjusted template services tests to include UTF8 no BOM files,
otherwise nuspec files would not be detected anymore.
@gep13 gep13 modified the milestones: 0.10.x, 0.10.16 Apr 16, 2021
gep13 added a commit that referenced this issue Apr 16, 2021
@gep13
Merge pull request #2064 from TheCakeIsNaOH/utf8-no-bom
071c9c3 
(GH-1364) Template create .nuspec encoded without BOM
@gep13 gep13 closed this as completed Apr 16, 2021
gep13 added a commit that referenced this issue Apr 19, 2021
@gep13
Merge branch 'stable' into master
5868c66 
* stable:
  (#1861) Improves terminology in help documentation
  (#1998) Add authorization header to Get-WebFile
  (maint) Repalce RawGit with raw.githack.com CDN
  (#1899) Remove unused variables
  (GH-1060) Add BeforeInstall parameter to Install-ChocolateyPackage.ps1
  (maint) Improve log message
  (GH-2092) Take all registry keys into account
  (GH-1364) Template create .nuspec encoded without BOM
  (#1866) Limit pending package removal to top level
  (GH-2203) Get-ChocolateyUnzip add unzipLocation alias
  (GH-1889) Fix: Removal of ApiKey broken
  (#2114) Remove unused variable
  (GH-2048) update deprecation note to outdated
  (maint) Spelling and grammar fixes
  (maint) Replace tabs with spaces
  (#2078) Skip importing Chocolatey GUI Extension
  (#2227) Use latest Mono and Ubuntu on Travis
steviecoaster added a commit to steviecoaster/choco that referenced this issue May 11, 2021
@steviecoaster
Merge branch 'GH2112' of https://github.com/steviecoaster/choco into …
61102d6 
…GH2112

* 'GH2112' of https://github.com/steviecoaster/choco:
  (chocolatey#2112) Add msp support to Install helper
  (maint) Switch to using a Regex match
  (maint) Change formatting
  (maint) Remove use of PowerShell aliases
  (maint) Replace " with '
  (chocolatey#2044) Fix for changing $env:Temp
  (chocolatey#2259) Switched to versioned NuGet.Core
  (chocolatey#2111) Deep copy config
  (chocolatey#2244) Add Mac build into main workflow
  (chocolatey#2238) Mono build don't hardcode xbuild path
  (maint) Fix artifact paths on AppVeyor
  (chocolatey#2244) Fix syntax for running on Windows
  (chocolatey#2244) Initial workflow for Windows and Ubuntu
  (doc) Remove Mono instructions for other distributions
  (doc) Add Ubuntu 20.04 mono install instructions
  (chocolatey#2227) Bump Mono version in Dockerfile and README
  (chocolatey#2236) Mono test work with merged usr systems
  (chocolatey#2190) Clarify help for SpecificFolder parameter
  (chocolatey#1962) Use different message on error
  (chocolatey#1861) Improves terminology in help documentation
  (chocolatey#1998) Add authorization header to Get-WebFile
  (maint) Repalce RawGit with raw.githack.com CDN
  (chocolatey#1899) Remove unused variables
  (chocolateyGH-1060) Add BeforeInstall parameter to Install-ChocolateyPackage.ps1
  (maint) Improve log message
  (chocolateyGH-2092) Take all registry keys into account
  (chocolateyGH-1364) Template create .nuspec encoded without BOM
  (chocolatey#1866) Limit pending package removal to top level
  (chocolateyGH-2203) Get-ChocolateyUnzip add unzipLocation alias
  (chocolateyGH-1889) Fix: Removal of ApiKey broken
  (chocolatey#2114) Remove unused variable
  (chocolateyGH-2048) update deprecation note to outdated
  (maint) Spelling and grammar fixes
  (maint) Replace tabs with spaces
  (chocolatey#2078) Skip importing Chocolatey GUI Extension
  (chocolatey#2227) Use latest Mono and Ubuntu on Travis
  (chocolatey#2205) Remove mention of private repository
  (chocolatey#2205) Update remaining URLs to new location
  (maint) Remove unnecessary whitespace
  (chocolatey#2231) Change default repository URL
  (maint) Remove unnecessary whitespace
  (chocolatey#2205) Update all chocolatey.org/docs URLs
  (maint) Remove unnecessary whitespace
  (chocolatey#2205) Update automatic-packages docs links
  (doc) Update to prefer # rather than GH-
  (maint) Fix replacement
  (maint) Revert change to earlier commit
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (doc) Update script to Statiq format
  (maint) Add missing backtick in example
  (maint) Added explicit link to new function name
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Fix spelling mistake
  (maint) Remove generated docs files
  (maint) Add docs/generated folder to ignore list
  (chocolateyGH-2105) Update link to Chocolatey workshop
@gep13 gep13 changed the title Choco new should output a .nuspec in UTF-8 without a byte order mark Ensure nuspec files generated from the choco new command use UTF-8 without a byte order mark May 18, 2021
@TheCakeIsNaOH TheCakeIsNaOH mentioned this issue Oct 19, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
5 - Released Improvement Priority_LOW
Projects
None yet
Milestone
0.11.0
Development

Successfully merging a pull request may close this issue.

(GH-1364) Template create .nuspec encoded without BOM TheCakeIsNaOH/choco
6 participants
@ferventcoder @gep13 @jnm2 @bcurran3 @Benny1007 @vexx32