From d7e3a1974ba968afd84faad207b8717f5faf6ad6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Viktor=20Sz=C3=A9pe?= Date: Fri, 10 May 2024 16:08:54 +0200 Subject: [PATCH] Fix typos (#6311) * Fix typos * Revert * Revert to "htlm" * fix indentations --- .github/CONTRIBUTING.md | 2 +- caddytest/caddytest.go | 6 +++--- listeners.go | 16 ++++++++-------- logging.go | 2 +- modules/caddyhttp/fileserver/browsetplcontext.go | 2 +- modules/caddyhttp/headers/headers.go | 2 +- modules/caddyhttp/ip_matchers.go | 2 +- modules/caddyhttp/templates/templates.go | 2 +- modules/caddytls/automation.go | 2 +- modules/caddytls/capools_test.go | 6 +++--- modules/caddytls/connpolicy.go | 2 +- modules/caddytls/internalissuer.go | 2 +- modules/caddytls/matchers.go | 4 ++-- 13 files changed, 25 insertions(+), 25 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 666ddef30..7142530e5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -25,7 +25,7 @@ Other menu items: You can have a huge impact on the project by helping with its code. To contribute code to Caddy, first submit or comment in an issue to discuss your contribution, then open a [pull request](https://github.com/caddyserver/caddy/pulls) (PR). If you're new to our community, that's okay: **we gladly welcome pull requests from anyone, regardless of your native language or coding experience.** You can get familiar with Caddy's code base by using [code search at Sourcegraph](https://sourcegraph.com/github.com/caddyserver/caddy). -We hold contributions to a high standard for quality :bowtie:, so don't be surprised if we ask for revisions—even if it seems small or insignificant. Please don't take it personally. :blue_heart: If your change is on the right track, we can guide you to make it mergable. +We hold contributions to a high standard for quality :bowtie:, so don't be surprised if we ask for revisions—even if it seems small or insignificant. Please don't take it personally. :blue_heart: If your change is on the right track, we can guide you to make it mergeable. Here are some of the expectations we have of contributors: diff --git a/caddytest/caddytest.go b/caddytest/caddytest.go index deb567b3b..3c6f95da7 100644 --- a/caddytest/caddytest.go +++ b/caddytest/caddytest.go @@ -36,7 +36,7 @@ type Defaults struct { // Port we expect caddy to listening on AdminPort int // Certificates we expect to be loaded before attempting to run the tests - Certifcates []string + Certificates []string // TestRequestTimeout is the time to wait for a http request to TestRequestTimeout time.Duration // LoadRequestTimeout is the time to wait for the config to be loaded against the caddy server @@ -46,7 +46,7 @@ type Defaults struct { // Default testing values var Default = Defaults{ AdminPort: 2999, // different from what a real server also running on a developer's machine might be - Certifcates: []string{"/caddy.localhost.crt", "/caddy.localhost.key"}, + Certificates: []string{"/caddy.localhost.crt", "/caddy.localhost.key"}, TestRequestTimeout: 5 * time.Second, LoadRequestTimeout: 5 * time.Second, } @@ -231,7 +231,7 @@ const initConfig = `{ // designated path and Caddy sub-process is running. func validateTestPrerequisites(t testing.TB) error { // check certificates are found - for _, certName := range Default.Certifcates { + for _, certName := range Default.Certificates { if _, err := os.Stat(getIntegrationDir() + certName); errors.Is(err, fs.ErrNotExist) { return fmt.Errorf("caddy integration test certificates (%s) not found", certName) } diff --git a/listeners.go b/listeners.go index dd02844dd..bb0e9b69c 100644 --- a/listeners.go +++ b/listeners.go @@ -149,11 +149,11 @@ func (na NetworkAddress) Listen(ctx context.Context, portOffset uint, config net func (na NetworkAddress) listen(ctx context.Context, portOffset uint, config net.ListenConfig) (any, error) { var ( - ln any - err error - address string - unixFileMode fs.FileMode - isAbtractUnixSocket bool + ln any + err error + address string + unixFileMode fs.FileMode + isAbstractUnixSocket bool ) // split unix socket addr early so lnKey @@ -164,7 +164,7 @@ func (na NetworkAddress) listen(ctx context.Context, portOffset uint, config net if err != nil { return nil, err } - isAbtractUnixSocket = strings.HasPrefix(address, "@") + isAbstractUnixSocket = strings.HasPrefix(address, "@") } else { address = na.JoinHostPort(portOffset) } @@ -172,7 +172,7 @@ func (na NetworkAddress) listen(ctx context.Context, portOffset uint, config net // if this is a unix socket, see if we already have it open, // force socket permissions on it and return early if socket, err := reuseUnixSocket(na.Network, address); socket != nil || err != nil { - if !isAbtractUnixSocket { + if !isAbstractUnixSocket { if err := os.Chmod(address, unixFileMode); err != nil { return nil, fmt.Errorf("unable to set permissions (%s) on %s: %v", unixFileMode, address, err) } @@ -195,7 +195,7 @@ func (na NetworkAddress) listen(ctx context.Context, portOffset uint, config net } if IsUnixNetwork(na.Network) { - if !isAbtractUnixSocket { + if !isAbstractUnixSocket { if err := os.Chmod(address, unixFileMode); err != nil { return nil, fmt.Errorf("unable to set permissions (%s) on %s: %v", unixFileMode, address, err) } diff --git a/logging.go b/logging.go index a076f062c..d3e7bf32b 100644 --- a/logging.go +++ b/logging.go @@ -372,7 +372,7 @@ func (cl *BaseLog) provisionCommon(ctx Context, logging *Logging) error { func (cl *BaseLog) buildCore() { // logs which only discard their output don't need // to perform encoding or any other processing steps - // at all, so just shorcut to a nop core instead + // at all, so just shortcut to a nop core instead if _, ok := cl.writerOpener.(*DiscardWriter); ok { cl.core = zapcore.NewNopCore() return diff --git a/modules/caddyhttp/fileserver/browsetplcontext.go b/modules/caddyhttp/fileserver/browsetplcontext.go index 307cb9a49..74c14608f 100644 --- a/modules/caddyhttp/fileserver/browsetplcontext.go +++ b/modules/caddyhttp/fileserver/browsetplcontext.go @@ -132,7 +132,7 @@ type browseTemplateContext struct { // The full path of the request. Path string `json:"path"` - // Whether the parent directory is browseable. + // Whether the parent directory is browsable. CanGoUp bool `json:"can_go_up"` // The items (files and folders) in the path. diff --git a/modules/caddyhttp/headers/headers.go b/modules/caddyhttp/headers/headers.go index ed503ef56..bdb185f46 100644 --- a/modules/caddyhttp/headers/headers.go +++ b/modules/caddyhttp/headers/headers.go @@ -184,7 +184,7 @@ type RespHeaderOps struct { Require *caddyhttp.ResponseMatcher `json:"require,omitempty"` // If true, header operations will be deferred until - // they are written out. Superceded if Require is set. + // they are written out. Superseded if Require is set. // Usually you will need to set this to true if any // fields are being deleted. Deferred bool `json:"deferred,omitempty"` diff --git a/modules/caddyhttp/ip_matchers.go b/modules/caddyhttp/ip_matchers.go index d5571802d..00d17487c 100644 --- a/modules/caddyhttp/ip_matchers.go +++ b/modules/caddyhttp/ip_matchers.go @@ -274,7 +274,7 @@ func parseIPZoneFromString(address string) (netip.Addr, string, error) { ipStr = address // OK; probably didn't have a port } - // Some IPv6-Adresses can contain zone identifiers at the end, + // Some IPv6-Addresses can contain zone identifiers at the end, // which are separated with "%" zoneID := "" if strings.Contains(ipStr, "%") { diff --git a/modules/caddyhttp/templates/templates.go b/modules/caddyhttp/templates/templates.go index b97093b6f..539666076 100644 --- a/modules/caddyhttp/templates/templates.go +++ b/modules/caddyhttp/templates/templates.go @@ -161,7 +161,7 @@ func init() { // Renders the given Markdown text as HTML and returns it. This uses the // [Goldmark](https://github.com/yuin/goldmark) library, // which is CommonMark compliant. It also has these extensions -// enabled: Github Flavored Markdown, Footnote, and syntax +// enabled: GitHub Flavored Markdown, Footnote, and syntax // highlighting provided by [Chroma](https://github.com/alecthomas/chroma). // // ``` diff --git a/modules/caddytls/automation.go b/modules/caddytls/automation.go index 803cb174e..3f98125d8 100644 --- a/modules/caddytls/automation.go +++ b/modules/caddytls/automation.go @@ -97,7 +97,7 @@ type AutomationPolicy struct { SubjectsRaw []string `json:"subjects,omitempty"` // The modules that may issue certificates. Default: internal if all - // subjects do not qualify for public certificates; othewise acme and + // subjects do not qualify for public certificates; otherwise acme and // zerossl. IssuersRaw []json.RawMessage `json:"issuers,omitempty" caddy:"namespace=tls.issuance inline_key=module"` diff --git a/modules/caddytls/capools_test.go b/modules/caddytls/capools_test.go index 67244b59a..b355792d1 100644 --- a/modules/caddytls/capools_test.go +++ b/modules/caddytls/capools_test.go @@ -547,7 +547,7 @@ func TestTLSConfig_unmarshalCaddyfile(t *testing.T) { wantErr: true, }, { - name: "setting 'ca' without arguemnt is an error", + name: "setting 'ca' without argument is an error", args: args{ d: caddyfile.NewTestDispenser(`{ ca @@ -710,7 +710,7 @@ func TestHTTPCertPoolUnmarshalCaddyfile(t *testing.T) { wantErr: false, }, { - name: "endpoints defiend inline and in block are merged", + name: "endpoints defined inline and in block are merged", args: args{ d: caddyfile.NewTestDispenser(`http http://localhost/ca-certs { endpoints http://remotehost/ca-certs @@ -722,7 +722,7 @@ func TestHTTPCertPoolUnmarshalCaddyfile(t *testing.T) { wantErr: false, }, { - name: "multiple endpoints defiend in block on the same line", + name: "multiple endpoints defined in block on the same line", args: args{ d: caddyfile.NewTestDispenser(`http { endpoints http://remotehost/ca-certs http://localhost/ca-certs diff --git a/modules/caddytls/connpolicy.go b/modules/caddytls/connpolicy.go index 38a01f3e4..c9705ffdc 100644 --- a/modules/caddytls/connpolicy.go +++ b/modules/caddytls/connpolicy.go @@ -517,7 +517,7 @@ func (ca *ClientAuthentication) UnmarshalCaddyfile(d *caddyfile.Dispenser) error _, ok := unm.(ClientCertificateVerifier) if !ok { - return d.Errf("module '%s' is not a caddytls.ClientCertificatVerifier", modID) + return d.Errf("module '%s' is not a caddytls.ClientCertificateVerifier", modID) } ca.VerifiersRaw = append(ca.VerifiersRaw, caddyconfig.JSONModuleObject(unm, "verifier", vType, nil)) default: diff --git a/modules/caddytls/internalissuer.go b/modules/caddytls/internalissuer.go index 0d7f4157e..f8dbc6f8c 100644 --- a/modules/caddytls/internalissuer.go +++ b/modules/caddytls/internalissuer.go @@ -94,7 +94,7 @@ func (iss *InternalIssuer) Provision(ctx caddy.Context) error { } // IssuerKey returns the unique issuer key for the -// confgured CA endpoint. +// configured CA endpoint. func (iss InternalIssuer) IssuerKey() string { return iss.ca.ID } diff --git a/modules/caddytls/matchers.go b/modules/caddytls/matchers.go index 17bfe2e4c..b01fb8334 100644 --- a/modules/caddytls/matchers.go +++ b/modules/caddytls/matchers.go @@ -110,7 +110,7 @@ func (m MatchRemoteIP) Match(hello *tls.ClientHelloInfo) bool { } ipAddr, err := netip.ParseAddr(ipStr) if err != nil { - m.logger.Error("invalid client IP addresss", zap.String("ip", ipStr)) + m.logger.Error("invalid client IP address", zap.String("ip", ipStr)) return false } return (len(m.cidrs) == 0 || m.matches(ipAddr, m.cidrs)) && @@ -185,7 +185,7 @@ func (m MatchLocalIP) Match(hello *tls.ClientHelloInfo) bool { } ipAddr, err := netip.ParseAddr(ipStr) if err != nil { - m.logger.Error("invalid local IP addresss", zap.String("ip", ipStr)) + m.logger.Error("invalid local IP address", zap.String("ip", ipStr)) return false } return (len(m.cidrs) == 0 || m.matches(ipAddr, m.cidrs))